Microsoft.DataFactory (stable:2018-06-01)

2025/09/26 • 102 new, 102 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 ,
}
,
]
,
dimensions:
{
Description: Defines the metric dimension. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dimension for the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the metric dimension. ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: Whether the dimension should be exported to Azure Monitor. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: 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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ExposureControl_GetFeatureValue (new)
Description :  Get exposure control feature for specific location.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/getFeatureValue
{
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 ,
exposureControlRequest:
{
Description: The exposure control request. ,
Required: True ,
}
{
featureName:
{
Description: The feature name. ,
Required: False ,
}
string ,
featureType:
{
Description: The feature type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
featureName:
{
Description: The feature name. ,
Required: False ,
}
string ,
value:
{
Description: The feature value. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ExposureControl_GetFeatureValueByFactory (new)
Description :  Get exposure control feature for specific factory.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getFeatureValue
{
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 ,
exposureControlRequest:
{
Description: The exposure control request. ,
Required: True ,
}
{
featureName:
{
Description: The feature name. ,
Required: False ,
}
string ,
featureType:
{
Description: The feature type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
featureName:
{
Description: The feature name. ,
Required: False ,
}
string ,
value:
{
Description: The feature value. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ExposureControl_QueryFeatureValuesByFactory (new)
Description :  Get list of exposure control features for specific factory.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryFeaturesValue
{
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 ,
exposureControlBatchRequest:
{
Description: The exposure control request for list of features. ,
Required: True ,
}
{
exposureControlRequests:
{
Description: List of exposure control features. ,
Required: True ,
}
[
{
featureName:
{
Description: The feature name. ,
Required: False ,
}
string ,
featureType:
{
Description: The feature type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
exposureControlResponses:
{
Description: List of exposure control feature values. ,
Required: True ,
}
[
{
featureName:
{
Description: The feature name. ,
Required: False ,
}
string ,
value:
{
Description: The feature value. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: 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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the factory entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of update the factory. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
If-None-Match:
{
Description: ETag of the factory entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_GetGitHubAccessToken (new)
Description :  Get GitHub Access Token.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getGitHubAccessToken
{
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 ,
gitHubAccessTokenRequest:
{
Description: Get GitHub access token request definition. ,
Required: True ,
}
{
gitHubAccessCode:
{
Description: GitHub access code. ,
Required: True ,
}
string ,
gitHubClientId:
{
Description: GitHub application client ID. ,
Required: False ,
}
string ,
gitHubClientSecret:
{
Description: GitHub bring your own app client secret information. ,
Required: False ,
}
{
byoaSecretAkvUrl:
{
Description: Bring your own app client secret AKV URL. ,
Required: False ,
}
string ,
byoaSecretName:
{
Description: Bring your own app client secret name in AKV. ,
Required: False ,
}
string ,
}
,
gitHubAccessTokenBaseUrl:
{
Description: GitHub access token base URL. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
gitHubAccessToken:
{
Description: GitHub access token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_GetDataPlaneAccess (new)
Description :  Get Data Plane access.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getDataPlaneAccess
{
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 ,
policy:
{
Description: Data Plane user access policy definition. ,
Required: True ,
}
{
permissions:
{
Description: The string with permissions for Data Plane access. Currently only 'r' is supported which grants read only access. ,
Required: False ,
}
string ,
accessResourcePath:
{
Description: The resource path to get access relative to factory. Currently only empty string is supported which corresponds to the factory resource. ,
Required: False ,
}
string ,
profileName:
{
Description: The name of the profile. Currently only the default is supported. The default value is DefaultProfile. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time for the token. If not specified the current time will be used. ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiration time for the token. Maximum duration for the token is eight hours and by default the token will expire in eight hours. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
policy:
{
Description: The user access policy. ,
Required: False ,
}
{
permissions:
{
Description: The string with permissions for Data Plane access. Currently only 'r' is supported which grants read only access. ,
Required: False ,
}
string ,
accessResourcePath:
{
Description: The resource path to get access relative to factory. Currently only empty string is supported which corresponds to the factory resource. ,
Required: False ,
}
string ,
profileName:
{
Description: The name of the profile. Currently only the default is supported. The default value is DefaultProfile. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time for the token. If not specified the current time will be used. ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiration time for the token. Maximum duration for the token is eight hours and by default the token will expire in eight hours. ,
Required: False ,
}
string ,
}
,
accessToken:
{
Description: Data Plane read only access token. ,
Required: False ,
}
string ,
dataPlaneUrl:
{
Description: Data Plane service base URL. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
If-None-Match:
{
Description: ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
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 (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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: True ,
}
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. ,
AccessDenied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_ListOutboundNetworkDependenciesEndpoints (new)
Description :  Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints
{
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)

{
value:
{
Description: The list of outbound network dependency endpoints. ,
Required: False ,
}
[
{
category:
{
Description: The category of outbound network dependency. ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints for outbound network dependency. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name of endpoint. ,
Required: False ,
}
string ,
endpointDetails:
{
Description: The details of endpoint. ,
Required: False ,
}
[
{
port:
{
Description: The port of endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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: True ,
}
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. ,
AccessDenied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
}
integer ,
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_CreateLinkedIntegrationRuntime (new)
Description :  Create a linked integration runtime entry in a shared integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/linkedIntegrationRuntime
{
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 ,
createLinkedIntegrationRuntimeRequest:
{
Description: The linked integration runtime properties. ,
Required: True ,
}
{
name:
{
Description: The name of the linked integration runtime. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that the linked integration runtime belongs to. ,
Required: False ,
}
string ,
dataFactoryName:
{
Description: The name of the data factory that the linked integration runtime belongs to. ,
Required: False ,
}
string ,
dataFactoryLocation:
{
Description: The location of the data factory that the linked integration runtime belongs to. ,
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: True ,
}
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. ,
AccessDenied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
IntegrationRuntimeObjectMetadata_Refresh (new)
Description :  Refresh a SSIS integration runtime object metadata.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata
{
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)

{
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
properties:
{
Description: The operation properties. ,
Required: False ,
}
string ,
error:
{
Description: The operation error message. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
IntegrationRuntimeObjectMetadata_Get (new)
Description :  Get a SSIS integration runtime object metadata by specified path. The return is pageable metadata list.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getObjectMetadata
{
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 ,
getMetadataRequest:
{
Description: The parameters for getting a SSIS object metadata. ,
Required: False ,
}
{
metadataPath:
{
Description: Metadata path. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SSIS object metadata. ,
Required: False ,
}
[
{
type:
{
Description: Type of metadata. ,
Enum:
{
Folder: No description available. ,
Project: No description available. ,
Package: No description available. ,
Environment: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Metadata id. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Metadata name. ,
Required: False ,
}
string ,
description:
{
Description: Metadata description. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_Get (new)
Description :  Gets a self-hosted integration runtime node.
Reference :  Link ¶

⚼ Request

GET:  /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)

{
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:
{
None: No description available. ,
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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:
{
None: No description available. ,
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
version:
{
Description: Version of the linked service. ,
Required: False ,
}
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 linked service. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
version:
{
Description: Version of the linked service. ,
Required: False ,
}
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 linked service. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
version:
{
Description: Version of the linked service. ,
Required: False ,
}
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 linked service. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
If-None-Match:
{
Description: ETag of the linked service entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
version:
{
Description: Version of the linked service. ,
Required: False ,
}
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 linked service. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
schema:
{
Description: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. ,
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 ,
]
,
folder:
{
Description: The folder that this Dataset is in. If not specified, Dataset will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Dataset is in. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
schema:
{
Description: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. ,
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 ,
]
,
folder:
{
Description: The folder that this Dataset is in. If not specified, Dataset will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Dataset is in. ,
Required: False ,
}
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 ,
schema:
{
Description: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. ,
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 ,
]
,
folder:
{
Description: The folder that this Dataset is in. If not specified, Dataset will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Dataset is in. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
If-None-Match:
{
Description: ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
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 ,
schema:
{
Description: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. ,
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 ,
]
,
folder:
{
Description: The folder that this Dataset is in. If not specified, Dataset will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Dataset is in. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
state:
{
Description: Activity state. This is an optional property and if not provided, the state will be Active by default. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
onInactiveMarkAs:
{
Description: Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
]
,
}
,
]
,
userProperties:
{
Description: Activity user properties. ,
Required: False ,
}
[
{
name:
{
Description: User property name. ,
Required: True ,
}
string ,
value:
{
Description: User property value. Type: string (or Expression with resultType string). ,
Required: True ,
}
object ,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
variables:
{
Description: List of variables 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 ,
]
,
runDimensions:
{
Description: Dimensions emitted by Pipeline. ,
Required: False ,
}
object ,
folder:
{
Description: The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Pipeline is in. ,
Required: False ,
}
string ,
}
,
policy:
{
Description: Pipeline Policy. ,
Required: False ,
}
{
elapsedTimeMetric:
{
Description: Pipeline ElapsedTime Metric Policy. ,
Required: False ,
}
{
duration:
{
Description: TimeSpan value, after which an Azure Monitoring Metric is fired. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
state:
{
Description: Activity state. This is an optional property and if not provided, the state will be Active by default. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
onInactiveMarkAs:
{
Description: Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
]
,
}
,
]
,
userProperties:
{
Description: Activity user properties. ,
Required: False ,
}
[
{
name:
{
Description: User property name. ,
Required: True ,
}
string ,
value:
{
Description: User property value. Type: string (or Expression with resultType string). ,
Required: True ,
}
object ,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
variables:
{
Description: List of variables 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 ,
]
,
runDimensions:
{
Description: Dimensions emitted by Pipeline. ,
Required: False ,
}
object ,
folder:
{
Description: The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Pipeline is in. ,
Required: False ,
}
string ,
}
,
policy:
{
Description: Pipeline Policy. ,
Required: False ,
}
{
elapsedTimeMetric:
{
Description: Pipeline ElapsedTime Metric Policy. ,
Required: False ,
}
{
duration:
{
Description: TimeSpan value, after which an Azure Monitoring Metric is fired. ,
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 ,
state:
{
Description: Activity state. This is an optional property and if not provided, the state will be Active by default. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
onInactiveMarkAs:
{
Description: Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
]
,
}
,
]
,
userProperties:
{
Description: Activity user properties. ,
Required: False ,
}
[
{
name:
{
Description: User property name. ,
Required: True ,
}
string ,
value:
{
Description: User property value. Type: string (or Expression with resultType string). ,
Required: True ,
}
object ,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
variables:
{
Description: List of variables 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 ,
]
,
runDimensions:
{
Description: Dimensions emitted by Pipeline. ,
Required: False ,
}
object ,
folder:
{
Description: The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Pipeline is in. ,
Required: False ,
}
string ,
}
,
policy:
{
Description: Pipeline Policy. ,
Required: False ,
}
{
elapsedTimeMetric:
{
Description: Pipeline ElapsedTime Metric Policy. ,
Required: False ,
}
{
duration:
{
Description: TimeSpan value, after which an Azure Monitoring Metric is fired. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
If-None-Match:
{
Description: ETag of the pipeline entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
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 ,
state:
{
Description: Activity state. This is an optional property and if not provided, the state will be Active by default. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
onInactiveMarkAs:
{
Description: Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
]
,
}
,
]
,
userProperties:
{
Description: Activity user properties. ,
Required: False ,
}
[
{
name:
{
Description: User property name. ,
Required: True ,
}
string ,
value:
{
Description: User property value. Type: string (or Expression with resultType string). ,
Required: True ,
}
object ,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
variables:
{
Description: List of variables 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 ,
]
,
runDimensions:
{
Description: Dimensions emitted by Pipeline. ,
Required: False ,
}
object ,
folder:
{
Description: The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Pipeline is in. ,
Required: False ,
}
string ,
}
,
policy:
{
Description: Pipeline Policy. ,
Required: False ,
}
{
elapsedTimeMetric:
{
Description: Pipeline ElapsedTime Metric Policy. ,
Required: False ,
}
{
duration:
{
Description: TimeSpan value, after which an Azure Monitoring Metric is fired. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
referencePipelineRunId:
{
Description: The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run. ,
Required: False ,
}
string ,
isRecovery:
{
Description: Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId. ,
Required: False ,
}
boolean ,
startActivityName:
{
Description: In recovery mode, the rerun will start from this activity. If not specified, all activities will run. ,
Required: False ,
}
string ,
startFromFailure:
{
Description: In recovery mode, if set to true, the rerun will start from failed activities. The property will be used only if startActivityName is not specified. ,
Required: False ,
}
boolean ,
parameters:
{
Description: Parameters of the pipeline run. These parameters will be used only if the runId is not specified. ,
Required: False ,
}
object ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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}/queryPipelineRuns
{
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 run event was updated in 'ISO 8601' format. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedBefore:
{
Description: The time at or before which the 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. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status. ,
Enum:
{
PipelineName: No description available. ,
Status: No description available. ,
RunStart: No description available. ,
RunEnd: No description available. ,
ActivityName: No description available. ,
ActivityRunStart: No description available. ,
ActivityRunEnd: No description available. ,
ActivityType: No description available. ,
TriggerName: No description available. ,
TriggerRunTimestamp: No description available. ,
RunGroupId: No description available. ,
LatestOnly: 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. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status. ,
Enum:
{
RunStart: No description available. ,
RunEnd: No description available. ,
PipelineName: No description available. ,
Status: No description available. ,
ActivityName: No description available. ,
ActivityRunStart: No description available. ,
ActivityRunEnd: No description available. ,
TriggerName: No description available. ,
TriggerRunTimestamp: 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 ,
runGroupId:
{
Description: Identifier that correlates all the recovery runs of a pipeline run. ,
Required: False ,
}
string ,
isLatest:
{
Description: Indicates if the recovered pipeline run is the latest in its group. ,
Required: False ,
}
boolean ,
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 ,
runDimensions:
{
Description: Run dimensions emitted by 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 ,
invokedByType:
{
Description: The type of the entity that started the run. ,
Required: False ,
}
string ,
pipelineName:
{
Description: The name of the pipeline that triggered the run, if any. ,
Required: False ,
}
string ,
pipelineRunId:
{
Description: The run id of the pipeline that triggered the run, if any. ,
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. Possible values: Queued, InProgress, Succeeded, Failed, Canceling, Cancelled ,
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
runGroupId:
{
Description: Identifier that correlates all the recovery runs of a pipeline run. ,
Required: False ,
}
string ,
isLatest:
{
Description: Indicates if the recovered pipeline run is the latest in its group. ,
Required: False ,
}
boolean ,
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 ,
runDimensions:
{
Description: Run dimensions emitted by 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 ,
invokedByType:
{
Description: The type of the entity that started the run. ,
Required: False ,
}
string ,
pipelineName:
{
Description: The name of the pipeline that triggered the run, if any. ,
Required: False ,
}
string ,
pipelineRunId:
{
Description: The run id of the pipeline that triggered the run, if any. ,
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. Possible values: Queued, InProgress, Succeeded, Failed, Canceling, Cancelled ,
Required: False ,
}
string ,
message:
{
Description: The message from a pipeline run. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_QueryByPipelineRun (new)
Description :  Query activity runs based on input filter conditions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns
{
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 ,
filterParameters:
{
Description: Parameters to filter the activity runs. ,
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 run event was updated in 'ISO 8601' format. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedBefore:
{
Description: The time at or before which the 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. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status. ,
Enum:
{
PipelineName: No description available. ,
Status: No description available. ,
RunStart: No description available. ,
RunEnd: No description available. ,
ActivityName: No description available. ,
ActivityRunStart: No description available. ,
ActivityRunEnd: No description available. ,
ActivityType: No description available. ,
TriggerName: No description available. ,
TriggerRunTimestamp: No description available. ,
RunGroupId: No description available. ,
LatestOnly: 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. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status. ,
Enum:
{
RunStart: No description available. ,
RunEnd: No description available. ,
PipelineName: No description available. ,
Status: No description available. ,
ActivityName: No description available. ,
ActivityRunStart: No description available. ,
ActivityRunEnd: No description available. ,
TriggerName: No description available. ,
TriggerRunTimestamp: 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 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 ,
}
,
]
,
continuationToken:
{
Description: The continuation token for getting the next page of results, if any remaining results exist, null otherwise. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_Cancel (new)
Description :  Cancel a pipeline run by its run ID.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/cancel
{
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 ,
isRecursive:
{
Description: If true, cancel all the Child pipelines that are triggered by the current pipeline. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
annotations:
{
Description: List of tags that can be used for describing the trigger. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_QueryByFactory (new)
Description :  Query triggers.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/querytriggers
{
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 triggers. ,
Required: True ,
}
{
continuationToken:
{
Description: The continuation token for getting the next page of results. Null for first page. ,
Required: False ,
}
string ,
parentTriggerName:
{
Description: The name of the parent TumblingWindowTrigger to get the child rerun triggers ,
Required: False ,
}
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 ,
annotations:
{
Description: List of tags that can be used for describing the trigger. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
continuationToken:
{
Description: The continuation token for getting the next page of results, if any remaining results exist, null otherwise. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
annotations:
{
Description: List of tags that can be used for describing the trigger. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
}

⚐ 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 ,
annotations:
{
Description: List of tags that can be used for describing the trigger. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
If-None-Match:
{
Description: ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
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 ,
annotations:
{
Description: List of tags that can be used for describing the trigger. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_SubscribeToEvents (new)
Description :  Subscribe event trigger to events.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/subscribeToEvents
{
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)

{
triggerName:
{
Description: Trigger name. ,
Required: False ,
}
string ,
status:
{
Description: Event Subscription Status. ,
Enum:
{
Enabled: No description available. ,
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Disabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_GetEventSubscriptionStatus (new)
Description :  Get a trigger's event subscription status.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/getEventSubscriptionStatus
{
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)

{
triggerName:
{
Description: Trigger name. ,
Required: False ,
}
string ,
status:
{
Description: Event Subscription Status. ,
Enum:
{
Enabled: No description available. ,
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Disabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_UnsubscribeFromEvents (new)
Description :  Unsubscribe event trigger from events.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/unsubscribeFromEvents
{
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)

{
triggerName:
{
Description: Trigger name. ,
Required: False ,
}
string ,
status:
{
Description: Event Subscription Status. ,
Enum:
{
Enabled: No description available. ,
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Disabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
TriggerRuns_Rerun (new)
Description :  Rerun single trigger instance by runId.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerRuns/{runId}/rerun
{
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 ,
runId:
{
Description: The pipeline run identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
TriggerRuns_Cancel (new)
Description :  Cancel a single trigger instance by runId.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerRuns/{runId}/cancel
{
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 ,
runId:
{
Description: The pipeline run identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
TriggerRuns_QueryByFactory (new)
Description :  Query trigger runs.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns
{
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 run event was updated in 'ISO 8601' format. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedBefore:
{
Description: The time at or before which the 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. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status. ,
Enum:
{
PipelineName: No description available. ,
Status: No description available. ,
RunStart: No description available. ,
RunEnd: No description available. ,
ActivityName: No description available. ,
ActivityRunStart: No description available. ,
ActivityRunEnd: No description available. ,
ActivityType: No description available. ,
TriggerName: No description available. ,
TriggerRunTimestamp: No description available. ,
RunGroupId: No description available. ,
LatestOnly: 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. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status. ,
Enum:
{
RunStart: No description available. ,
RunEnd: No description available. ,
PipelineName: No description available. ,
Status: No description available. ,
ActivityName: No description available. ,
ActivityRunStart: No description available. ,
ActivityRunEnd: No description available. ,
TriggerName: No description available. ,
TriggerRunTimestamp: 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 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 ,
runDimension:
{
Description: Run dimension for which trigger was fired. ,
Required: False ,
}
object ,
dependencyStatus:
{
Description: Status of the upstream pipelines. ,
Required: False ,
}
object ,
}
,
]
,
continuationToken:
{
Description: The continuation token for getting the next page of results, if any remaining results exist, null otherwise. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlows_CreateOrUpdate (new)
Description :  Creates or updates a data flow.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}
{
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 ,
dataFlowName:
{
Description: The data flow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
dataFlow:
{
Description: Data flow resource definition. ,
Required: True ,
}
{
properties:
{
Description: Data flow properties. ,
Required: True ,
}
{
type:
{
Description: Type of data flow. ,
Required: True ,
}
string ,
description:
{
Description: The description of the data flow. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the data flow. ,
Required: False ,
}
[
object ,
]
,
folder:
{
Description: The folder that this data flow is in. If not specified, Data flow will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this data flow is in. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Data flow properties. ,
Required: True ,
}
{
type:
{
Description: Type of data flow. ,
Required: True ,
}
string ,
description:
{
Description: The description of the data flow. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the data flow. ,
Required: False ,
}
[
object ,
]
,
folder:
{
Description: The folder that this data flow is in. If not specified, Data flow will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this data flow is in. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlows_Get (new)
Description :  Gets a data flow.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}
{
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 ,
dataFlowName:
{
Description: The data flow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-None-Match:
{
Description: ETag of the data flow entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Data flow properties. ,
Required: True ,
}
{
type:
{
Description: Type of data flow. ,
Required: True ,
}
string ,
description:
{
Description: The description of the data flow. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the data flow. ,
Required: False ,
}
[
object ,
]
,
folder:
{
Description: The folder that this data flow is in. If not specified, Data flow will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this data flow is in. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlows_Delete (new)
Description :  Deletes a data flow.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}
{
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 ,
dataFlowName:
{
Description: The data flow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlows_ListByFactory (new)
Description :  Lists data flows.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows
{
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 data flows. ,
Required: True ,
}
[
{
properties:
{
Description: Data flow properties. ,
Required: True ,
}
{
type:
{
Description: Type of data flow. ,
Required: True ,
}
string ,
description:
{
Description: The description of the data flow. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the data flow. ,
Required: False ,
}
[
object ,
]
,
folder:
{
Description: The folder that this data flow is in. If not specified, Data flow will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this data flow is in. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlowDebugSession_Create (new)
Description :  Creates a data flow debug session.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/createDataFlowDebugSession
{
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 ,
request:
{
Description: Data flow debug session definition ,
Required: True ,
}
{
computeType:
{
Description: Compute type of the cluster. The value will be overwritten by the same setting in integration runtime if provided. ,
Required: False ,
}
string ,
coreCount:
{
Description: Core count of the cluster. The value will be overwritten by the same setting in integration runtime if provided. ,
Required: False ,
}
integer ,
timeToLive:
{
Description: Time to live setting of the cluster in minutes. ,
Required: False ,
}
integer ,
integrationRuntime:
{
Description: Set to use integration runtime setting for data flow debug session. ,
Required: False ,
}
{
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 (202)

{
location:
{
Description: URI to poll for asynchronous operation status. ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The state of the debug session. ,
Required: False ,
}
string ,
sessionId:
{
Description: The ID of data flow debug session. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlowDebugSession_QueryByFactory (new)
Description :  Query all active data flow debug sessions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryDataFlowDebugSessions
{
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: Array with all active debug sessions. ,
Required: False ,
}
[
{
dataFlowName:
{
Description: The name of the data flow. ,
Required: False ,
}
string ,
computeType:
{
Description: Compute type of the cluster. ,
Required: False ,
}
string ,
coreCount:
{
Description: Core count of the cluster. ,
Required: False ,
}
integer ,
nodeCount:
{
Description: Node count of the cluster. (deprecated property) ,
Required: False ,
}
integer ,
integrationRuntimeName:
{
Description: Attached integration runtime name of data flow debug session. ,
Required: False ,
}
string ,
sessionId:
{
Description: The ID of data flow debug session. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of data flow debug session. ,
Required: False ,
}
string ,
timeToLiveInMinutes:
{
Description: Compute type of the cluster. ,
Required: False ,
}
integer ,
lastActivityTime:
{
Description: Last activity time of data flow debug session. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlowDebugSession_AddDataFlow (new)
Description :  Add a data flow into debug session.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/addDataFlowToDebugSession
{
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 ,
request:
{
Description: Data flow debug session definition with debug content. ,
Required: True ,
}
{
sessionId:
{
Description: The ID of data flow debug session. ,
Required: False ,
}
string ,
dataFlow:
{
Description: Data flow instance. ,
Required: False ,
}
{
properties:
{
Description: Data flow properties. ,
Required: True ,
}
{
type:
{
Description: Type of data flow. ,
Required: True ,
}
string ,
description:
{
Description: The description of the data flow. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the data flow. ,
Required: False ,
}
[
object ,
]
,
folder:
{
Description: The folder that this data flow is in. If not specified, Data flow will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this data flow is in. ,
Required: False ,
}
string ,
}
,
}
,
}
,
dataFlows:
{
Description: List of Data flows ,
Required: False ,
}
[
{
properties:
{
Description: Data flow properties. ,
Required: True ,
}
{
type:
{
Description: Type of data flow. ,
Required: True ,
}
string ,
description:
{
Description: The description of the data flow. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the data flow. ,
Required: False ,
}
[
object ,
]
,
folder:
{
Description: The folder that this data flow is in. If not specified, Data flow will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this data flow is in. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
datasets:
{
Description: List of datasets. ,
Required: False ,
}
[
{
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 ,
schema:
{
Description: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. ,
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 ,
]
,
folder:
{
Description: The folder that this Dataset is in. If not specified, Dataset will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Dataset is in. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
linkedServices:
{
Description: List of linked services. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
version:
{
Description: Version of the linked service. ,
Required: False ,
}
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 linked service. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
staging:
{
Description: Staging info for debug session. ,
Required: False ,
}
{
linkedService:
{
Description: Staging linked service reference. ,
Required: False ,
}
{
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 ,
}
,
folderPath:
{
Description: Folder path for staging blob. Type: string (or Expression with resultType string) ,
Required: False ,
}
object ,
}
,
debugSettings:
{
Description: Data flow debug settings. ,
Required: False ,
}
{
sourceSettings:
{
Description: Source setting for data flow debug. ,
Required: False ,
}
[
{
sourceName:
{
Description: The data flow source name. ,
Required: False ,
}
string ,
rowLimit:
{
Description: Defines the row limit of data flow source in debug. ,
Required: False ,
}
integer ,
}
,
]
,
parameters:
{
Description: Data flow parameters. ,
Required: False ,
}
object ,
datasetParameters:
{
Description: Parameters for dataset. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
jobVersion:
{
Description: The ID of data flow debug job version. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlowDebugSession_Delete (new)
Description :  Deletes a data flow debug session.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/deleteDataFlowDebugSession
{
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 ,
request:
{
Description: Data flow debug session definition for deletion ,
Required: True ,
}
{
sessionId:
{
Description: The ID of data flow debug session. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlowDebugSession_ExecuteCommand (new)
Description :  Execute a data flow debug command.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/executeDataFlowDebugCommand
{
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 ,
request:
{
Description: Data flow debug command definition. ,
Required: True ,
}
{
sessionId:
{
Description: The ID of data flow debug session. ,
Required: False ,
}
string ,
command:
{
Description: The command type. ,
Enum:
{
executePreviewQuery: No description available. ,
executeStatisticsQuery: No description available. ,
executeExpressionQuery: No description available. ,
}
,
Required: False ,
}
enum ,
commandPayload:
{
Description: The command payload object. ,
Required: False ,
}
{
streamName:
{
Description: The stream name which is used for preview. ,
Required: True ,
}
string ,
rowLimits:
{
Description: Row limits for preview response. ,
Required: False ,
}
integer ,
columns:
{
Description: Array of column names. ,
Required: False ,
}
[
string ,
]
,
expression:
{
Description: The expression which is used for preview. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URI to poll for asynchronous operation status. ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The run status of data preview, statistics or expression preview. ,
Required: False ,
}
string ,
data:
{
Description: The result data of data preview, statistics or expression preview. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedVirtualNetworks_ListByFactory (new)
Description :  Lists managed Virtual Networks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks
{
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 managed Virtual Networks. ,
Required: True ,
}
[
{
properties:
{
Description: Managed Virtual Network properties. ,
Required: True ,
}
{
vNetId:
{
Description: Managed Virtual Network ID. ,
Required: False ,
}
string ,
alias:
{
Description: Managed Virtual Network alias. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedVirtualNetworks_CreateOrUpdate (new)
Description :  Creates or updates a managed Virtual Network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}
{
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 ,
managedVirtualNetworkName:
{
Description: Managed virtual network name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the managed Virtual Network entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
managedVirtualNetwork:
{
Description: Managed Virtual Network resource definition. ,
Required: True ,
}
{
properties:
{
Description: Managed Virtual Network properties. ,
Required: True ,
}
{
vNetId:
{
Description: Managed Virtual Network ID. ,
Required: False ,
}
string ,
alias:
{
Description: Managed Virtual Network alias. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Managed Virtual Network properties. ,
Required: True ,
}
{
vNetId:
{
Description: Managed Virtual Network ID. ,
Required: False ,
}
string ,
alias:
{
Description: Managed Virtual Network alias. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedVirtualNetworks_Get (new)
Description :  Gets a managed Virtual Network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}
{
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 ,
managedVirtualNetworkName:
{
Description: Managed virtual network name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-None-Match:
{
Description: ETag of the managed Virtual Network entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Managed Virtual Network properties. ,
Required: True ,
}
{
vNetId:
{
Description: Managed Virtual Network ID. ,
Required: False ,
}
string ,
alias:
{
Description: Managed Virtual Network alias. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedPrivateEndpoints_ListByFactory (new)
Description :  Lists managed private endpoints.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints
{
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 ,
managedVirtualNetworkName:
{
Description: Managed virtual network name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of managed private endpoints. ,
Required: True ,
}
[
{
properties:
{
Description: Managed private endpoint properties. ,
Required: True ,
}
{
connectionState:
{
Description: The managed private endpoint connection state ,
Required: False ,
}
{
actionsRequired:
{
Description: The actions required on the managed private endpoint ,
Required: False ,
}
string ,
description:
{
Description: The managed private endpoint description ,
Required: False ,
}
string ,
status:
{
Description: The approval status ,
Required: False ,
}
string ,
}
,
fqdns:
{
Description: Fully qualified domain names ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: The groupId to which the managed private endpoint is created ,
Required: False ,
}
string ,
isReserved:
{
Description: Denotes whether the managed private endpoint is reserved ,
Required: False ,
}
boolean ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource to which the managed private endpoint is created ,
Required: False ,
}
string ,
provisioningState:
{
Description: The managed private endpoint provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
CredentialOperations_ListByFactory (new)
Description :  List credentials.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials
{
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 credentials. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of credentials. ,
Required: True ,
}
{
type:
{
Description: Type of credential. ,
Required: True ,
}
string ,
description:
{
Description: Credential description. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the Credential. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
CredentialOperations_CreateOrUpdate (new)
Description :  Creates or updates a credential.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}
{
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 ,
credentialName:
{
Description: Credential name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the credential entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
credential:
{
Description: Credential resource definition. ,
Required: True ,
}
{
properties:
{
Description: Properties of credentials. ,
Required: True ,
}
{
type:
{
Description: Type of credential. ,
Required: True ,
}
string ,
description:
{
Description: Credential description. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the Credential. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of credentials. ,
Required: True ,
}
{
type:
{
Description: Type of credential. ,
Required: True ,
}
string ,
description:
{
Description: Credential description. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the Credential. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
CredentialOperations_Get (new)
Description :  Gets a credential.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}
{
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 ,
credentialName:
{
Description: Credential name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-None-Match:
{
Description: ETag of the credential entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of credentials. ,
Required: True ,
}
{
type:
{
Description: Type of credential. ,
Required: True ,
}
string ,
description:
{
Description: Credential description. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the Credential. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
CredentialOperations_Delete (new)
Description :  Deletes a credential.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}
{
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 ,
credentialName:
{
Description: Credential name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedPrivateEndpoints_CreateOrUpdate (new)
Description :  Creates or updates a managed private endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}
{
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 ,
managedVirtualNetworkName:
{
Description: Managed virtual network name ,
Required: True ,
}
string ,
managedPrivateEndpointName:
{
Description: Managed private endpoint name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the managed private endpoint entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
managedPrivateEndpoint:
{
Description: Managed private endpoint resource definition. ,
Required: True ,
}
{
properties:
{
Description: Managed private endpoint properties. ,
Required: True ,
}
{
connectionState:
{
Description: The managed private endpoint connection state ,
Required: False ,
}
{
actionsRequired:
{
Description: The actions required on the managed private endpoint ,
Required: False ,
}
string ,
description:
{
Description: The managed private endpoint description ,
Required: False ,
}
string ,
status:
{
Description: The approval status ,
Required: False ,
}
string ,
}
,
fqdns:
{
Description: Fully qualified domain names ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: The groupId to which the managed private endpoint is created ,
Required: False ,
}
string ,
isReserved:
{
Description: Denotes whether the managed private endpoint is reserved ,
Required: False ,
}
boolean ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource to which the managed private endpoint is created ,
Required: False ,
}
string ,
provisioningState:
{
Description: The managed private endpoint provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Managed private endpoint properties. ,
Required: True ,
}
{
connectionState:
{
Description: The managed private endpoint connection state ,
Required: False ,
}
{
actionsRequired:
{
Description: The actions required on the managed private endpoint ,
Required: False ,
}
string ,
description:
{
Description: The managed private endpoint description ,
Required: False ,
}
string ,
status:
{
Description: The approval status ,
Required: False ,
}
string ,
}
,
fqdns:
{
Description: Fully qualified domain names ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: The groupId to which the managed private endpoint is created ,
Required: False ,
}
string ,
isReserved:
{
Description: Denotes whether the managed private endpoint is reserved ,
Required: False ,
}
boolean ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource to which the managed private endpoint is created ,
Required: False ,
}
string ,
provisioningState:
{
Description: The managed private endpoint provisioning state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedPrivateEndpoints_Get (new)
Description :  Gets a managed private endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}
{
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 ,
managedVirtualNetworkName:
{
Description: Managed virtual network name ,
Required: True ,
}
string ,
managedPrivateEndpointName:
{
Description: Managed private endpoint name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-None-Match:
{
Description: ETag of the managed private endpoint entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Managed private endpoint properties. ,
Required: True ,
}
{
connectionState:
{
Description: The managed private endpoint connection state ,
Required: False ,
}
{
actionsRequired:
{
Description: The actions required on the managed private endpoint ,
Required: False ,
}
string ,
description:
{
Description: The managed private endpoint description ,
Required: False ,
}
string ,
status:
{
Description: The approval status ,
Required: False ,
}
string ,
}
,
fqdns:
{
Description: Fully qualified domain names ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: The groupId to which the managed private endpoint is created ,
Required: False ,
}
string ,
isReserved:
{
Description: Denotes whether the managed private endpoint is reserved ,
Required: False ,
}
boolean ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource to which the managed private endpoint is created ,
Required: False ,
}
string ,
provisioningState:
{
Description: The managed private endpoint provisioning state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedPrivateEndpoints_Delete (new)
Description :  Deletes a managed private endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}
{
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 ,
managedVirtualNetworkName:
{
Description: Managed virtual network name ,
Required: True ,
}
string ,
managedPrivateEndpointName:
{
Description: Managed private endpoint name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
privateEndPointConnections_ListByFactory (new)
Description :  Lists Private endpoint connections
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndPointConnections
{
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 Private Endpoint Connections. ,
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: PrivateEndpoint of a remote private endpoint connection ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The state of a private link connection ,
Required: False ,
}
{
status:
{
Description: Status of a private link connection ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: ActionsRequired for a private link connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
PrivateEndpointConnection_CreateOrUpdate (new)
Description :  Approves or rejects a private endpoint connection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the private endpoint connection entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
privateEndpointWrapper:
{
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
privateLinkServiceConnectionState:
{
Description: The state of a private link connection ,
Required: False ,
}
{
status:
{
Description: Status of a private link connection ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: ActionsRequired for a private link connection ,
Required: False ,
}
string ,
}
,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: PrivateEndpoint of a remote private endpoint connection ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The state of a private link connection ,
Required: False ,
}
{
status:
{
Description: Status of a private link connection ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: ActionsRequired for a private link connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
PrivateEndpointConnection_Get (new)
Description :  Gets a private endpoint connection
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-None-Match:
{
Description: ETag of the private endpoint connection entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: PrivateEndpoint of a remote private endpoint connection ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The state of a private link connection ,
Required: False ,
}
{
status:
{
Description: Status of a private link connection ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: ActionsRequired for a private link connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
PrivateEndpointConnection_Delete (new)
Description :  Deletes a private endpoint connection
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
privateLinkResources_Get (new)
Description :  Gets the private link resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateLinkResources
{
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:
{
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
groupId:
{
Description: GroupId of a private link resource ,
Required: False ,
}
string ,
requiredMembers:
{
Description: RequiredMembers of a private link resource ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: RequiredZoneNames of a private link resource ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
GlobalParameters_ListByFactory (new)
Description :  Lists Global parameters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters
{
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 global parameters. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the global parameter. ,
Required: True ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
GlobalParameters_Get (new)
Description :  Gets a Global parameter
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}
{
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 ,
globalParameterName:
{
Description: The global parameter name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the global parameter. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
GlobalParameters_CreateOrUpdate (new)
Description :  Creates or updates a Global parameter
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}
{
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 ,
globalParameterName:
{
Description: The global parameter name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
default:
{
Description: Global parameter resource definition. ,
Required: True ,
}
{
properties:
{
Description: Properties of the global parameter. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the global parameter. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
GlobalParameters_Delete (new)
Description :  Deletes a Global parameter
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}
{
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 ,
globalParameterName:
{
Description: The global parameter name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_ListByFactory (new)
Description :  Lists all resources of type change data capture.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs
{
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: Lists all resources of type change data capture. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the change data capture. ,
Required: True ,
}
{
folder:
{
Description: The folder that this CDC is in. If not specified, CDC will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this CDC is in. ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the change data capture. ,
Required: False ,
}
string ,
sourceConnectionsInfo:
{
Description: List of sources connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
sourceEntities:
{
Description: List of source tables for a source connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
targetConnectionsInfo:
{
Description: List of target connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
targetEntities:
{
Description: List of source tables for a target connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
dataMapperMappings:
{
Description: List of table mappings. ,
Required: False ,
}
[
{
targetEntityName:
{
Description: Name of the target table ,
Required: False ,
}
string ,
sourceEntityName:
{
Description: Name of the source table ,
Required: False ,
}
string ,
sourceConnectionReference:
{
Description: The connection reference for the source connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attributeMappingInfo:
{
Description: This holds the user provided attribute mapping information. ,
Required: False ,
}
{
attributeMappings:
{
Description: List of attribute mappings. ,
Required: False ,
}
[
{
name:
{
Description: Name of the target column. ,
Required: False ,
}
string ,
type:
{
Description: Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'. ,
Enum:
{
Direct: No description available. ,
Derived: No description available. ,
Aggregate: No description available. ,
}
,
Required: False ,
}
enum ,
functionName:
{
Description: Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping. ,
Required: False ,
}
string ,
expression:
{
Description: Expression used for 'Aggregate' and 'Derived' type mapping. ,
Required: False ,
}
string ,
attributeReference:
{
Description: Reference of the source column used in the mapping. It is used for 'Direct' mapping type only. ,
Required: False ,
}
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
attributeReferences:
{
Description: List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
sourceDenormalizeInfo:
{
Description: This holds the source denormalization information used while joining multiple sources. ,
Required: False ,
}
object ,
}
,
]
,
relationships:
{
Description: List of relationship info among the tables. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
policy:
{
Description: CDC policy ,
Required: True ,
}
{
mode:
{
Description: Mode of running the CDC: batch vs continuous. ,
Required: False ,
}
string ,
recurrence:
{
Description: Defines the frequency and interval for running the CDC for batch mode. ,
Required: False ,
}
{
frequency:
{
Description: Frequency of period in terms of 'Hour', 'Minute' or 'Second'. ,
Enum:
{
Hour: No description available. ,
Minute: No description available. ,
Second: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Actual interval value as per chosen frequency. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
allowVNetOverride:
{
Description: A boolean to determine if the vnet configuration needs to be overwritten. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the CDC as to if it is running or stopped. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_CreateOrUpdate (new)
Description :  Creates or updates a change data capture resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}
{
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 ,
changeDataCaptureName:
{
Description: The change data capture name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the change data capture entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
changeDataCapture:
{
Description: Change data capture resource definition. ,
Required: True ,
}
{
properties:
{
Description: Properties of the change data capture. ,
Required: True ,
}
{
folder:
{
Description: The folder that this CDC is in. If not specified, CDC will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this CDC is in. ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the change data capture. ,
Required: False ,
}
string ,
sourceConnectionsInfo:
{
Description: List of sources connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
sourceEntities:
{
Description: List of source tables for a source connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
targetConnectionsInfo:
{
Description: List of target connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
targetEntities:
{
Description: List of source tables for a target connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
dataMapperMappings:
{
Description: List of table mappings. ,
Required: False ,
}
[
{
targetEntityName:
{
Description: Name of the target table ,
Required: False ,
}
string ,
sourceEntityName:
{
Description: Name of the source table ,
Required: False ,
}
string ,
sourceConnectionReference:
{
Description: The connection reference for the source connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attributeMappingInfo:
{
Description: This holds the user provided attribute mapping information. ,
Required: False ,
}
{
attributeMappings:
{
Description: List of attribute mappings. ,
Required: False ,
}
[
{
name:
{
Description: Name of the target column. ,
Required: False ,
}
string ,
type:
{
Description: Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'. ,
Enum:
{
Direct: No description available. ,
Derived: No description available. ,
Aggregate: No description available. ,
}
,
Required: False ,
}
enum ,
functionName:
{
Description: Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping. ,
Required: False ,
}
string ,
expression:
{
Description: Expression used for 'Aggregate' and 'Derived' type mapping. ,
Required: False ,
}
string ,
attributeReference:
{
Description: Reference of the source column used in the mapping. It is used for 'Direct' mapping type only. ,
Required: False ,
}
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
attributeReferences:
{
Description: List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
sourceDenormalizeInfo:
{
Description: This holds the source denormalization information used while joining multiple sources. ,
Required: False ,
}
object ,
}
,
]
,
relationships:
{
Description: List of relationship info among the tables. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
policy:
{
Description: CDC policy ,
Required: True ,
}
{
mode:
{
Description: Mode of running the CDC: batch vs continuous. ,
Required: False ,
}
string ,
recurrence:
{
Description: Defines the frequency and interval for running the CDC for batch mode. ,
Required: False ,
}
{
frequency:
{
Description: Frequency of period in terms of 'Hour', 'Minute' or 'Second'. ,
Enum:
{
Hour: No description available. ,
Minute: No description available. ,
Second: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Actual interval value as per chosen frequency. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
allowVNetOverride:
{
Description: A boolean to determine if the vnet configuration needs to be overwritten. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the CDC as to if it is running or stopped. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the change data capture. ,
Required: True ,
}
{
folder:
{
Description: The folder that this CDC is in. If not specified, CDC will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this CDC is in. ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the change data capture. ,
Required: False ,
}
string ,
sourceConnectionsInfo:
{
Description: List of sources connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
sourceEntities:
{
Description: List of source tables for a source connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
targetConnectionsInfo:
{
Description: List of target connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
targetEntities:
{
Description: List of source tables for a target connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
dataMapperMappings:
{
Description: List of table mappings. ,
Required: False ,
}
[
{
targetEntityName:
{
Description: Name of the target table ,
Required: False ,
}
string ,
sourceEntityName:
{
Description: Name of the source table ,
Required: False ,
}
string ,
sourceConnectionReference:
{
Description: The connection reference for the source connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attributeMappingInfo:
{
Description: This holds the user provided attribute mapping information. ,
Required: False ,
}
{
attributeMappings:
{
Description: List of attribute mappings. ,
Required: False ,
}
[
{
name:
{
Description: Name of the target column. ,
Required: False ,
}
string ,
type:
{
Description: Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'. ,
Enum:
{
Direct: No description available. ,
Derived: No description available. ,
Aggregate: No description available. ,
}
,
Required: False ,
}
enum ,
functionName:
{
Description: Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping. ,
Required: False ,
}
string ,
expression:
{
Description: Expression used for 'Aggregate' and 'Derived' type mapping. ,
Required: False ,
}
string ,
attributeReference:
{
Description: Reference of the source column used in the mapping. It is used for 'Direct' mapping type only. ,
Required: False ,
}
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
attributeReferences:
{
Description: List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
sourceDenormalizeInfo:
{
Description: This holds the source denormalization information used while joining multiple sources. ,
Required: False ,
}
object ,
}
,
]
,
relationships:
{
Description: List of relationship info among the tables. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
policy:
{
Description: CDC policy ,
Required: True ,
}
{
mode:
{
Description: Mode of running the CDC: batch vs continuous. ,
Required: False ,
}
string ,
recurrence:
{
Description: Defines the frequency and interval for running the CDC for batch mode. ,
Required: False ,
}
{
frequency:
{
Description: Frequency of period in terms of 'Hour', 'Minute' or 'Second'. ,
Enum:
{
Hour: No description available. ,
Minute: No description available. ,
Second: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Actual interval value as per chosen frequency. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
allowVNetOverride:
{
Description: A boolean to determine if the vnet configuration needs to be overwritten. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the CDC as to if it is running or stopped. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_Get (new)
Description :  Gets a change data capture.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}
{
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 ,
changeDataCaptureName:
{
Description: The change data capture name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-None-Match:
{
Description: ETag of the change data capture entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the change data capture. ,
Required: True ,
}
{
folder:
{
Description: The folder that this CDC is in. If not specified, CDC will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this CDC is in. ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the change data capture. ,
Required: False ,
}
string ,
sourceConnectionsInfo:
{
Description: List of sources connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
sourceEntities:
{
Description: List of source tables for a source connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
targetConnectionsInfo:
{
Description: List of target connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
targetEntities:
{
Description: List of source tables for a target connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
dataMapperMappings:
{
Description: List of table mappings. ,
Required: False ,
}
[
{
targetEntityName:
{
Description: Name of the target table ,
Required: False ,
}
string ,
sourceEntityName:
{
Description: Name of the source table ,
Required: False ,
}
string ,
sourceConnectionReference:
{
Description: The connection reference for the source connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attributeMappingInfo:
{
Description: This holds the user provided attribute mapping information. ,
Required: False ,
}
{
attributeMappings:
{
Description: List of attribute mappings. ,
Required: False ,
}
[
{
name:
{
Description: Name of the target column. ,
Required: False ,
}
string ,
type:
{
Description: Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'. ,
Enum:
{
Direct: No description available. ,
Derived: No description available. ,
Aggregate: No description available. ,
}
,
Required: False ,
}
enum ,
functionName:
{
Description: Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping. ,
Required: False ,
}
string ,
expression:
{
Description: Expression used for 'Aggregate' and 'Derived' type mapping. ,
Required: False ,
}
string ,
attributeReference:
{
Description: Reference of the source column used in the mapping. It is used for 'Direct' mapping type only. ,
Required: False ,
}
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
attributeReferences:
{
Description: List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
sourceDenormalizeInfo:
{
Description: This holds the source denormalization information used while joining multiple sources. ,
Required: False ,
}
object ,
}
,
]
,
relationships:
{
Description: List of relationship info among the tables. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
policy:
{
Description: CDC policy ,
Required: True ,
}
{
mode:
{
Description: Mode of running the CDC: batch vs continuous. ,
Required: False ,
}
string ,
recurrence:
{
Description: Defines the frequency and interval for running the CDC for batch mode. ,
Required: False ,
}
{
frequency:
{
Description: Frequency of period in terms of 'Hour', 'Minute' or 'Second'. ,
Enum:
{
Hour: No description available. ,
Minute: No description available. ,
Second: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Actual interval value as per chosen frequency. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
allowVNetOverride:
{
Description: A boolean to determine if the vnet configuration needs to be overwritten. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the CDC as to if it is running or stopped. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_Delete (new)
Description :  Deletes a change data capture.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}
{
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 ,
changeDataCaptureName:
{
Description: The change data capture name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_Start (new)
Description :  Starts a change data capture.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/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 ,
changeDataCaptureName:
{
Description: The change data capture name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_Stop (new)
Description :  Stops a change data capture.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/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 ,
changeDataCaptureName:
{
Description: The change data capture name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_Status (new)
Description :  Gets the current status for the change data capture resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/status
{
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 ,
changeDataCaptureName:
{
Description: The change data capture name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Current status of the change data capture resource. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
}
,
]
,
dimensions:
{
Description: Defines the metric dimension. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dimension for the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the metric dimension. ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: Whether the dimension should be exported to Azure Monitor. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: 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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ExposureControl_GetFeatureValue (removed)
Description :  Get exposure control feature for specific location.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/getFeatureValue
{
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 ,
exposureControlRequest:
{
Description: The exposure control request. ,
Required: True ,
}
{
featureName:
{
Description: The feature name. ,
Required: False ,
}
string ,
featureType:
{
Description: The feature type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
featureName:
{
Description: The feature name. ,
Required: False ,
}
string ,
value:
{
Description: The feature value. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ExposureControl_GetFeatureValueByFactory (removed)
Description :  Get exposure control feature for specific factory.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getFeatureValue
{
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 ,
exposureControlRequest:
{
Description: The exposure control request. ,
Required: True ,
}
{
featureName:
{
Description: The feature name. ,
Required: False ,
}
string ,
featureType:
{
Description: The feature type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
featureName:
{
Description: The feature name. ,
Required: False ,
}
string ,
value:
{
Description: The feature value. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ExposureControl_QueryFeatureValuesByFactory (removed)
Description :  Get list of exposure control features for specific factory.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryFeaturesValue
{
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 ,
exposureControlBatchRequest:
{
Description: The exposure control request for list of features. ,
Required: True ,
}
{
exposureControlRequests:
{
Description: List of exposure control features. ,
Required: True ,
}
[
{
featureName:
{
Description: The feature name. ,
Required: False ,
}
string ,
featureType:
{
Description: The feature type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
exposureControlResponses:
{
Description: List of exposure control feature values. ,
Required: True ,
}
[
{
featureName:
{
Description: The feature name. ,
Required: False ,
}
string ,
value:
{
Description: The feature value. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: 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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: ETag of the factory entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Properties of update the factory. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
If-None-Match:
{
Description: ETag of the factory entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity of the factory. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: 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 ,
userAssignedIdentities:
{
Description: List of user assigned identities for the factory. ,
Required: False ,
}
object ,
}
,
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 ,
purviewConfiguration:
{
Description: Purview information of the factory. ,
Required: False ,
}
{
purviewResourceId:
{
Description: Purview resource id. ,
Required: False ,
}
string ,
}
,
repoConfiguration:
{
Description: Git repo information of the factory. ,
Required: False ,
}
{
type:
{
Description: Type of repo configuration. ,
Required: True ,
}
string ,
accountName:
{
Description: Account name. ,
Required: True ,
}
string ,
repositoryName:
{
Description: Repository name. ,
Required: True ,
}
string ,
collaborationBranch:
{
Description: Collaboration branch. ,
Required: True ,
}
string ,
rootFolder:
{
Description: Root folder. ,
Required: True ,
}
string ,
lastCommitId:
{
Description: Last commit id. ,
Required: False ,
}
string ,
disablePublish:
{
Description: Disable manual publish operation in ADF studio to favor automated publish. ,
Required: False ,
}
boolean ,
}
,
globalParameters:
{
Description: List of parameters for factory. ,
Required: False ,
}
object ,
encryption:
{
Description: Properties to enable Customer Managed Key for the factory. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key in Azure Key Vault to use as Customer Managed Key. ,
Required: True ,
}
string ,
vaultBaseUrl:
{
Description: The url of the Azure Key Vault used for CMK. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key used for CMK. If not provided, latest version will be used. ,
Required: False ,
}
string ,
identity:
{
Description: User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The resource id of the user assigned identity to authenticate to customer's key vault. ,
Required: False ,
}
string ,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the data factory. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_GetGitHubAccessToken (removed)
Description :  Get GitHub Access Token.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getGitHubAccessToken
{
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 ,
gitHubAccessTokenRequest:
{
Description: Get GitHub access token request definition. ,
Required: True ,
}
{
gitHubAccessCode:
{
Description: GitHub access code. ,
Required: True ,
}
string ,
gitHubClientId:
{
Description: GitHub application client ID. ,
Required: False ,
}
string ,
gitHubClientSecret:
{
Description: GitHub bring your own app client secret information. ,
Required: False ,
}
{
byoaSecretAkvUrl:
{
Description: Bring your own app client secret AKV URL. ,
Required: False ,
}
string ,
byoaSecretName:
{
Description: Bring your own app client secret name in AKV. ,
Required: False ,
}
string ,
}
,
gitHubAccessTokenBaseUrl:
{
Description: GitHub access token base URL. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
gitHubAccessToken:
{
Description: GitHub access token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_GetDataPlaneAccess (removed)
Description :  Get Data Plane access.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getDataPlaneAccess
{
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 ,
policy:
{
Description: Data Plane user access policy definition. ,
Required: True ,
}
{
permissions:
{
Description: The string with permissions for Data Plane access. Currently only 'r' is supported which grants read only access. ,
Required: False ,
}
string ,
accessResourcePath:
{
Description: The resource path to get access relative to factory. Currently only empty string is supported which corresponds to the factory resource. ,
Required: False ,
}
string ,
profileName:
{
Description: The name of the profile. Currently only the default is supported. The default value is DefaultProfile. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time for the token. If not specified the current time will be used. ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiration time for the token. Maximum duration for the token is eight hours and by default the token will expire in eight hours. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
policy:
{
Description: The user access policy. ,
Required: False ,
}
{
permissions:
{
Description: The string with permissions for Data Plane access. Currently only 'r' is supported which grants read only access. ,
Required: False ,
}
string ,
accessResourcePath:
{
Description: The resource path to get access relative to factory. Currently only empty string is supported which corresponds to the factory resource. ,
Required: False ,
}
string ,
profileName:
{
Description: The name of the profile. Currently only the default is supported. The default value is DefaultProfile. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time for the token. If not specified the current time will be used. ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiration time for the token. Maximum duration for the token is eight hours and by default the token will expire in eight hours. ,
Required: False ,
}
string ,
}
,
accessToken:
{
Description: Data Plane read only access token. ,
Required: False ,
}
string ,
dataPlaneUrl:
{
Description: Data Plane service base URL. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
If-None-Match:
{
Description: ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
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 (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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: True ,
}
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. ,
AccessDenied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_ListOutboundNetworkDependenciesEndpoints (removed)
Description :  Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints
{
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)

{
value:
{
Description: The list of outbound network dependency endpoints. ,
Required: False ,
}
[
{
category:
{
Description: The category of outbound network dependency. ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints for outbound network dependency. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name of endpoint. ,
Required: False ,
}
string ,
endpointDetails:
{
Description: The details of endpoint. ,
Required: False ,
}
[
{
port:
{
Description: The port of endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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: True ,
}
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. ,
AccessDenied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
}
integer ,
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_CreateLinkedIntegrationRuntime (removed)
Description :  Create a linked integration runtime entry in a shared integration runtime.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/linkedIntegrationRuntime
{
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 ,
createLinkedIntegrationRuntimeRequest:
{
Description: The linked integration runtime properties. ,
Required: True ,
}
{
name:
{
Description: The name of the linked integration runtime. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that the linked integration runtime belongs to. ,
Required: False ,
}
string ,
dataFactoryName:
{
Description: The name of the data factory that the linked integration runtime belongs to. ,
Required: False ,
}
string ,
dataFactoryLocation:
{
Description: The location of the data factory that the linked integration runtime belongs to. ,
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: True ,
}
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. ,
AccessDenied: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
IntegrationRuntimeObjectMetadata_Refresh (removed)
Description :  Refresh a SSIS integration runtime object metadata.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata
{
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)

{
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
properties:
{
Description: The operation properties. ,
Required: False ,
}
string ,
error:
{
Description: The operation error message. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
IntegrationRuntimeObjectMetadata_Get (removed)
Description :  Get a SSIS integration runtime object metadata by specified path. The return is pageable metadata list.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getObjectMetadata
{
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 ,
getMetadataRequest:
{
Description: The parameters for getting a SSIS object metadata. ,
Required: False ,
}
{
metadataPath:
{
Description: Metadata path. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SSIS object metadata. ,
Required: False ,
}
[
{
type:
{
Description: Type of metadata. ,
Enum:
{
Folder: No description available. ,
Project: No description available. ,
Package: No description available. ,
Environment: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Metadata id. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Metadata name. ,
Required: False ,
}
string ,
description:
{
Description: Metadata description. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_Get (removed)
Description :  Gets a self-hosted integration runtime node.
Reference :  Link ¶

⚼ Request

GET:  /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)

{
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:
{
None: No description available. ,
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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:
{
None: No description available. ,
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
version:
{
Description: Version of the linked service. ,
Required: False ,
}
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 linked service. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
version:
{
Description: Version of the linked service. ,
Required: False ,
}
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 linked service. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
version:
{
Description: Version of the linked service. ,
Required: False ,
}
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 linked service. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
If-None-Match:
{
Description: ETag of the linked service entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
version:
{
Description: Version of the linked service. ,
Required: False ,
}
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 linked service. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
schema:
{
Description: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. ,
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 ,
]
,
folder:
{
Description: The folder that this Dataset is in. If not specified, Dataset will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Dataset is in. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
schema:
{
Description: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. ,
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 ,
]
,
folder:
{
Description: The folder that this Dataset is in. If not specified, Dataset will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Dataset is in. ,
Required: False ,
}
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 ,
schema:
{
Description: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. ,
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 ,
]
,
folder:
{
Description: The folder that this Dataset is in. If not specified, Dataset will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Dataset is in. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
If-None-Match:
{
Description: ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
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 ,
schema:
{
Description: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. ,
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 ,
]
,
folder:
{
Description: The folder that this Dataset is in. If not specified, Dataset will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Dataset is in. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
state:
{
Description: Activity state. This is an optional property and if not provided, the state will be Active by default. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
onInactiveMarkAs:
{
Description: Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
]
,
}
,
]
,
userProperties:
{
Description: Activity user properties. ,
Required: False ,
}
[
{
name:
{
Description: User property name. ,
Required: True ,
}
string ,
value:
{
Description: User property value. Type: string (or Expression with resultType string). ,
Required: True ,
}
object ,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
variables:
{
Description: List of variables 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 ,
]
,
runDimensions:
{
Description: Dimensions emitted by Pipeline. ,
Required: False ,
}
object ,
folder:
{
Description: The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Pipeline is in. ,
Required: False ,
}
string ,
}
,
policy:
{
Description: Pipeline Policy. ,
Required: False ,
}
{
elapsedTimeMetric:
{
Description: Pipeline ElapsedTime Metric Policy. ,
Required: False ,
}
{
duration:
{
Description: TimeSpan value, after which an Azure Monitoring Metric is fired. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
state:
{
Description: Activity state. This is an optional property and if not provided, the state will be Active by default. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
onInactiveMarkAs:
{
Description: Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
]
,
}
,
]
,
userProperties:
{
Description: Activity user properties. ,
Required: False ,
}
[
{
name:
{
Description: User property name. ,
Required: True ,
}
string ,
value:
{
Description: User property value. Type: string (or Expression with resultType string). ,
Required: True ,
}
object ,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
variables:
{
Description: List of variables 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 ,
]
,
runDimensions:
{
Description: Dimensions emitted by Pipeline. ,
Required: False ,
}
object ,
folder:
{
Description: The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Pipeline is in. ,
Required: False ,
}
string ,
}
,
policy:
{
Description: Pipeline Policy. ,
Required: False ,
}
{
elapsedTimeMetric:
{
Description: Pipeline ElapsedTime Metric Policy. ,
Required: False ,
}
{
duration:
{
Description: TimeSpan value, after which an Azure Monitoring Metric is fired. ,
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 ,
state:
{
Description: Activity state. This is an optional property and if not provided, the state will be Active by default. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
onInactiveMarkAs:
{
Description: Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
]
,
}
,
]
,
userProperties:
{
Description: Activity user properties. ,
Required: False ,
}
[
{
name:
{
Description: User property name. ,
Required: True ,
}
string ,
value:
{
Description: User property value. Type: string (or Expression with resultType string). ,
Required: True ,
}
object ,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
variables:
{
Description: List of variables 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 ,
]
,
runDimensions:
{
Description: Dimensions emitted by Pipeline. ,
Required: False ,
}
object ,
folder:
{
Description: The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Pipeline is in. ,
Required: False ,
}
string ,
}
,
policy:
{
Description: Pipeline Policy. ,
Required: False ,
}
{
elapsedTimeMetric:
{
Description: Pipeline ElapsedTime Metric Policy. ,
Required: False ,
}
{
duration:
{
Description: TimeSpan value, after which an Azure Monitoring Metric is fired. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
If-None-Match:
{
Description: ETag of the pipeline entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
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 ,
state:
{
Description: Activity state. This is an optional property and if not provided, the state will be Active by default. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
onInactiveMarkAs:
{
Description: Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
]
,
}
,
]
,
userProperties:
{
Description: Activity user properties. ,
Required: False ,
}
[
{
name:
{
Description: User property name. ,
Required: True ,
}
string ,
value:
{
Description: User property value. Type: string (or Expression with resultType string). ,
Required: True ,
}
object ,
}
,
]
,
}
,
]
,
parameters:
{
Description: List of parameters for pipeline. ,
Required: False ,
}
object ,
variables:
{
Description: List of variables 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 ,
]
,
runDimensions:
{
Description: Dimensions emitted by Pipeline. ,
Required: False ,
}
object ,
folder:
{
Description: The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Pipeline is in. ,
Required: False ,
}
string ,
}
,
policy:
{
Description: Pipeline Policy. ,
Required: False ,
}
{
elapsedTimeMetric:
{
Description: Pipeline ElapsedTime Metric Policy. ,
Required: False ,
}
{
duration:
{
Description: TimeSpan value, after which an Azure Monitoring Metric is fired. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
referencePipelineRunId:
{
Description: The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run. ,
Required: False ,
}
string ,
isRecovery:
{
Description: Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId. ,
Required: False ,
}
boolean ,
startActivityName:
{
Description: In recovery mode, the rerun will start from this activity. If not specified, all activities will run. ,
Required: False ,
}
string ,
startFromFailure:
{
Description: In recovery mode, if set to true, the rerun will start from failed activities. The property will be used only if startActivityName is not specified. ,
Required: False ,
}
boolean ,
parameters:
{
Description: Parameters of the pipeline run. These parameters will be used only if the runId is not specified. ,
Required: False ,
}
object ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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}/queryPipelineRuns
{
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 run event was updated in 'ISO 8601' format. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedBefore:
{
Description: The time at or before which the 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. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status. ,
Enum:
{
PipelineName: No description available. ,
Status: No description available. ,
RunStart: No description available. ,
RunEnd: No description available. ,
ActivityName: No description available. ,
ActivityRunStart: No description available. ,
ActivityRunEnd: No description available. ,
ActivityType: No description available. ,
TriggerName: No description available. ,
TriggerRunTimestamp: No description available. ,
RunGroupId: No description available. ,
LatestOnly: 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. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status. ,
Enum:
{
RunStart: No description available. ,
RunEnd: No description available. ,
PipelineName: No description available. ,
Status: No description available. ,
ActivityName: No description available. ,
ActivityRunStart: No description available. ,
ActivityRunEnd: No description available. ,
TriggerName: No description available. ,
TriggerRunTimestamp: 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 ,
runGroupId:
{
Description: Identifier that correlates all the recovery runs of a pipeline run. ,
Required: False ,
}
string ,
isLatest:
{
Description: Indicates if the recovered pipeline run is the latest in its group. ,
Required: False ,
}
boolean ,
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 ,
runDimensions:
{
Description: Run dimensions emitted by 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 ,
invokedByType:
{
Description: The type of the entity that started the run. ,
Required: False ,
}
string ,
pipelineName:
{
Description: The name of the pipeline that triggered the run, if any. ,
Required: False ,
}
string ,
pipelineRunId:
{
Description: The run id of the pipeline that triggered the run, if any. ,
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. Possible values: Queued, InProgress, Succeeded, Failed, Canceling, Cancelled ,
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
runGroupId:
{
Description: Identifier that correlates all the recovery runs of a pipeline run. ,
Required: False ,
}
string ,
isLatest:
{
Description: Indicates if the recovered pipeline run is the latest in its group. ,
Required: False ,
}
boolean ,
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 ,
runDimensions:
{
Description: Run dimensions emitted by 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 ,
invokedByType:
{
Description: The type of the entity that started the run. ,
Required: False ,
}
string ,
pipelineName:
{
Description: The name of the pipeline that triggered the run, if any. ,
Required: False ,
}
string ,
pipelineRunId:
{
Description: The run id of the pipeline that triggered the run, if any. ,
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. Possible values: Queued, InProgress, Succeeded, Failed, Canceling, Cancelled ,
Required: False ,
}
string ,
message:
{
Description: The message from a pipeline run. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_QueryByPipelineRun (removed)
Description :  Query activity runs based on input filter conditions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns
{
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 ,
filterParameters:
{
Description: Parameters to filter the activity runs. ,
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 run event was updated in 'ISO 8601' format. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedBefore:
{
Description: The time at or before which the 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. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status. ,
Enum:
{
PipelineName: No description available. ,
Status: No description available. ,
RunStart: No description available. ,
RunEnd: No description available. ,
ActivityName: No description available. ,
ActivityRunStart: No description available. ,
ActivityRunEnd: No description available. ,
ActivityType: No description available. ,
TriggerName: No description available. ,
TriggerRunTimestamp: No description available. ,
RunGroupId: No description available. ,
LatestOnly: 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. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status. ,
Enum:
{
RunStart: No description available. ,
RunEnd: No description available. ,
PipelineName: No description available. ,
Status: No description available. ,
ActivityName: No description available. ,
ActivityRunStart: No description available. ,
ActivityRunEnd: No description available. ,
TriggerName: No description available. ,
TriggerRunTimestamp: 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 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 ,
}
,
]
,
continuationToken:
{
Description: The continuation token for getting the next page of results, if any remaining results exist, null otherwise. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_Cancel (removed)
Description :  Cancel a pipeline run by its run ID.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/cancel
{
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 ,
isRecursive:
{
Description: If true, cancel all the Child pipelines that are triggered by the current pipeline. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
annotations:
{
Description: List of tags that can be used for describing the trigger. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_QueryByFactory (removed)
Description :  Query triggers.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/querytriggers
{
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 triggers. ,
Required: True ,
}
{
continuationToken:
{
Description: The continuation token for getting the next page of results. Null for first page. ,
Required: False ,
}
string ,
parentTriggerName:
{
Description: The name of the parent TumblingWindowTrigger to get the child rerun triggers ,
Required: False ,
}
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 ,
annotations:
{
Description: List of tags that can be used for describing the trigger. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
continuationToken:
{
Description: The continuation token for getting the next page of results, if any remaining results exist, null otherwise. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
annotations:
{
Description: List of tags that can be used for describing the trigger. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
}

⚐ 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 ,
annotations:
{
Description: List of tags that can be used for describing the trigger. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
If-None-Match:
{
Description: ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
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 ,
annotations:
{
Description: List of tags that can be used for describing the trigger. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_SubscribeToEvents (removed)
Description :  Subscribe event trigger to events.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/subscribeToEvents
{
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)

{
triggerName:
{
Description: Trigger name. ,
Required: False ,
}
string ,
status:
{
Description: Event Subscription Status. ,
Enum:
{
Enabled: No description available. ,
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Disabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_GetEventSubscriptionStatus (removed)
Description :  Get a trigger's event subscription status.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/getEventSubscriptionStatus
{
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)

{
triggerName:
{
Description: Trigger name. ,
Required: False ,
}
string ,
status:
{
Description: Event Subscription Status. ,
Enum:
{
Enabled: No description available. ,
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Disabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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_UnsubscribeFromEvents (removed)
Description :  Unsubscribe event trigger from events.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/unsubscribeFromEvents
{
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)

{
triggerName:
{
Description: Trigger name. ,
Required: False ,
}
string ,
status:
{
Description: Event Subscription Status. ,
Enum:
{
Enabled: No description available. ,
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Disabled: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
TriggerRuns_Rerun (removed)
Description :  Rerun single trigger instance by runId.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerRuns/{runId}/rerun
{
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 ,
runId:
{
Description: The pipeline run identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
TriggerRuns_Cancel (removed)
Description :  Cancel a single trigger instance by runId.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerRuns/{runId}/cancel
{
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 ,
runId:
{
Description: The pipeline run identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
TriggerRuns_QueryByFactory (removed)
Description :  Query trigger runs.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns
{
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 run event was updated in 'ISO 8601' format. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedBefore:
{
Description: The time at or before which the 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. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status. ,
Enum:
{
PipelineName: No description available. ,
Status: No description available. ,
RunStart: No description available. ,
RunEnd: No description available. ,
ActivityName: No description available. ,
ActivityRunStart: No description available. ,
ActivityRunEnd: No description available. ,
ActivityType: No description available. ,
TriggerName: No description available. ,
TriggerRunTimestamp: No description available. ,
RunGroupId: No description available. ,
LatestOnly: 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. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status. ,
Enum:
{
RunStart: No description available. ,
RunEnd: No description available. ,
PipelineName: No description available. ,
Status: No description available. ,
ActivityName: No description available. ,
ActivityRunStart: No description available. ,
ActivityRunEnd: No description available. ,
TriggerName: No description available. ,
TriggerRunTimestamp: 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 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 ,
runDimension:
{
Description: Run dimension for which trigger was fired. ,
Required: False ,
}
object ,
dependencyStatus:
{
Description: Status of the upstream pipelines. ,
Required: False ,
}
object ,
}
,
]
,
continuationToken:
{
Description: The continuation token for getting the next page of results, if any remaining results exist, null otherwise. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlows_CreateOrUpdate (removed)
Description :  Creates or updates a data flow.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}
{
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 ,
dataFlowName:
{
Description: The data flow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
dataFlow:
{
Description: Data flow resource definition. ,
Required: True ,
}
{
properties:
{
Description: Data flow properties. ,
Required: True ,
}
{
type:
{
Description: Type of data flow. ,
Required: True ,
}
string ,
description:
{
Description: The description of the data flow. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the data flow. ,
Required: False ,
}
[
object ,
]
,
folder:
{
Description: The folder that this data flow is in. If not specified, Data flow will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this data flow is in. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Data flow properties. ,
Required: True ,
}
{
type:
{
Description: Type of data flow. ,
Required: True ,
}
string ,
description:
{
Description: The description of the data flow. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the data flow. ,
Required: False ,
}
[
object ,
]
,
folder:
{
Description: The folder that this data flow is in. If not specified, Data flow will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this data flow is in. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlows_Get (removed)
Description :  Gets a data flow.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}
{
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 ,
dataFlowName:
{
Description: The data flow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-None-Match:
{
Description: ETag of the data flow entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Data flow properties. ,
Required: True ,
}
{
type:
{
Description: Type of data flow. ,
Required: True ,
}
string ,
description:
{
Description: The description of the data flow. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the data flow. ,
Required: False ,
}
[
object ,
]
,
folder:
{
Description: The folder that this data flow is in. If not specified, Data flow will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this data flow is in. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlows_Delete (removed)
Description :  Deletes a data flow.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}
{
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 ,
dataFlowName:
{
Description: The data flow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlows_ListByFactory (removed)
Description :  Lists data flows.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows
{
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 data flows. ,
Required: True ,
}
[
{
properties:
{
Description: Data flow properties. ,
Required: True ,
}
{
type:
{
Description: Type of data flow. ,
Required: True ,
}
string ,
description:
{
Description: The description of the data flow. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the data flow. ,
Required: False ,
}
[
object ,
]
,
folder:
{
Description: The folder that this data flow is in. If not specified, Data flow will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this data flow is in. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlowDebugSession_Create (removed)
Description :  Creates a data flow debug session.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/createDataFlowDebugSession
{
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 ,
request:
{
Description: Data flow debug session definition ,
Required: True ,
}
{
computeType:
{
Description: Compute type of the cluster. The value will be overwritten by the same setting in integration runtime if provided. ,
Required: False ,
}
string ,
coreCount:
{
Description: Core count of the cluster. The value will be overwritten by the same setting in integration runtime if provided. ,
Required: False ,
}
integer ,
timeToLive:
{
Description: Time to live setting of the cluster in minutes. ,
Required: False ,
}
integer ,
integrationRuntime:
{
Description: Set to use integration runtime setting for data flow debug session. ,
Required: False ,
}
{
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 (202)

{
location:
{
Description: URI to poll for asynchronous operation status. ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The state of the debug session. ,
Required: False ,
}
string ,
sessionId:
{
Description: The ID of data flow debug session. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlowDebugSession_QueryByFactory (removed)
Description :  Query all active data flow debug sessions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryDataFlowDebugSessions
{
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: Array with all active debug sessions. ,
Required: False ,
}
[
{
dataFlowName:
{
Description: The name of the data flow. ,
Required: False ,
}
string ,
computeType:
{
Description: Compute type of the cluster. ,
Required: False ,
}
string ,
coreCount:
{
Description: Core count of the cluster. ,
Required: False ,
}
integer ,
nodeCount:
{
Description: Node count of the cluster. (deprecated property) ,
Required: False ,
}
integer ,
integrationRuntimeName:
{
Description: Attached integration runtime name of data flow debug session. ,
Required: False ,
}
string ,
sessionId:
{
Description: The ID of data flow debug session. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of data flow debug session. ,
Required: False ,
}
string ,
timeToLiveInMinutes:
{
Description: Compute type of the cluster. ,
Required: False ,
}
integer ,
lastActivityTime:
{
Description: Last activity time of data flow debug session. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlowDebugSession_AddDataFlow (removed)
Description :  Add a data flow into debug session.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/addDataFlowToDebugSession
{
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 ,
request:
{
Description: Data flow debug session definition with debug content. ,
Required: True ,
}
{
sessionId:
{
Description: The ID of data flow debug session. ,
Required: False ,
}
string ,
dataFlow:
{
Description: Data flow instance. ,
Required: False ,
}
{
properties:
{
Description: Data flow properties. ,
Required: True ,
}
{
type:
{
Description: Type of data flow. ,
Required: True ,
}
string ,
description:
{
Description: The description of the data flow. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the data flow. ,
Required: False ,
}
[
object ,
]
,
folder:
{
Description: The folder that this data flow is in. If not specified, Data flow will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this data flow is in. ,
Required: False ,
}
string ,
}
,
}
,
}
,
dataFlows:
{
Description: List of Data flows ,
Required: False ,
}
[
{
properties:
{
Description: Data flow properties. ,
Required: True ,
}
{
type:
{
Description: Type of data flow. ,
Required: True ,
}
string ,
description:
{
Description: The description of the data flow. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the data flow. ,
Required: False ,
}
[
object ,
]
,
folder:
{
Description: The folder that this data flow is in. If not specified, Data flow will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this data flow is in. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
datasets:
{
Description: List of datasets. ,
Required: False ,
}
[
{
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 ,
schema:
{
Description: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. ,
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 ,
]
,
folder:
{
Description: The folder that this Dataset is in. If not specified, Dataset will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this Dataset is in. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
linkedServices:
{
Description: List of linked services. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of linked service. ,
Required: True ,
}
{
type:
{
Description: Type of linked service. ,
Required: True ,
}
string ,
version:
{
Description: Version of the linked service. ,
Required: False ,
}
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 linked service. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
staging:
{
Description: Staging info for debug session. ,
Required: False ,
}
{
linkedService:
{
Description: Staging linked service reference. ,
Required: False ,
}
{
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 ,
}
,
folderPath:
{
Description: Folder path for staging blob. Type: string (or Expression with resultType string) ,
Required: False ,
}
object ,
}
,
debugSettings:
{
Description: Data flow debug settings. ,
Required: False ,
}
{
sourceSettings:
{
Description: Source setting for data flow debug. ,
Required: False ,
}
[
{
sourceName:
{
Description: The data flow source name. ,
Required: False ,
}
string ,
rowLimit:
{
Description: Defines the row limit of data flow source in debug. ,
Required: False ,
}
integer ,
}
,
]
,
parameters:
{
Description: Data flow parameters. ,
Required: False ,
}
object ,
datasetParameters:
{
Description: Parameters for dataset. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
jobVersion:
{
Description: The ID of data flow debug job version. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlowDebugSession_Delete (removed)
Description :  Deletes a data flow debug session.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/deleteDataFlowDebugSession
{
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 ,
request:
{
Description: Data flow debug session definition for deletion ,
Required: True ,
}
{
sessionId:
{
Description: The ID of data flow debug session. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
DataFlowDebugSession_ExecuteCommand (removed)
Description :  Execute a data flow debug command.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/executeDataFlowDebugCommand
{
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 ,
request:
{
Description: Data flow debug command definition. ,
Required: True ,
}
{
sessionId:
{
Description: The ID of data flow debug session. ,
Required: False ,
}
string ,
command:
{
Description: The command type. ,
Enum:
{
executePreviewQuery: No description available. ,
executeStatisticsQuery: No description available. ,
executeExpressionQuery: No description available. ,
}
,
Required: False ,
}
enum ,
commandPayload:
{
Description: The command payload object. ,
Required: False ,
}
{
streamName:
{
Description: The stream name which is used for preview. ,
Required: True ,
}
string ,
rowLimits:
{
Description: Row limits for preview response. ,
Required: False ,
}
integer ,
columns:
{
Description: Array of column names. ,
Required: False ,
}
[
string ,
]
,
expression:
{
Description: The expression which is used for preview. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URI to poll for asynchronous operation status. ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The run status of data preview, statistics or expression preview. ,
Required: False ,
}
string ,
data:
{
Description: The result data of data preview, statistics or expression preview. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedVirtualNetworks_ListByFactory (removed)
Description :  Lists managed Virtual Networks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks
{
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 managed Virtual Networks. ,
Required: True ,
}
[
{
properties:
{
Description: Managed Virtual Network properties. ,
Required: True ,
}
{
vNetId:
{
Description: Managed Virtual Network ID. ,
Required: False ,
}
string ,
alias:
{
Description: Managed Virtual Network alias. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedVirtualNetworks_CreateOrUpdate (removed)
Description :  Creates or updates a managed Virtual Network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}
{
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 ,
managedVirtualNetworkName:
{
Description: Managed virtual network name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the managed Virtual Network entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
managedVirtualNetwork:
{
Description: Managed Virtual Network resource definition. ,
Required: True ,
}
{
properties:
{
Description: Managed Virtual Network properties. ,
Required: True ,
}
{
vNetId:
{
Description: Managed Virtual Network ID. ,
Required: False ,
}
string ,
alias:
{
Description: Managed Virtual Network alias. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Managed Virtual Network properties. ,
Required: True ,
}
{
vNetId:
{
Description: Managed Virtual Network ID. ,
Required: False ,
}
string ,
alias:
{
Description: Managed Virtual Network alias. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedVirtualNetworks_Get (removed)
Description :  Gets a managed Virtual Network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}
{
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 ,
managedVirtualNetworkName:
{
Description: Managed virtual network name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-None-Match:
{
Description: ETag of the managed Virtual Network entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Managed Virtual Network properties. ,
Required: True ,
}
{
vNetId:
{
Description: Managed Virtual Network ID. ,
Required: False ,
}
string ,
alias:
{
Description: Managed Virtual Network alias. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedPrivateEndpoints_ListByFactory (removed)
Description :  Lists managed private endpoints.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints
{
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 ,
managedVirtualNetworkName:
{
Description: Managed virtual network name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of managed private endpoints. ,
Required: True ,
}
[
{
properties:
{
Description: Managed private endpoint properties. ,
Required: True ,
}
{
connectionState:
{
Description: The managed private endpoint connection state ,
Required: False ,
}
{
actionsRequired:
{
Description: The actions required on the managed private endpoint ,
Required: False ,
}
string ,
description:
{
Description: The managed private endpoint description ,
Required: False ,
}
string ,
status:
{
Description: The approval status ,
Required: False ,
}
string ,
}
,
fqdns:
{
Description: Fully qualified domain names ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: The groupId to which the managed private endpoint is created ,
Required: False ,
}
string ,
isReserved:
{
Description: Denotes whether the managed private endpoint is reserved ,
Required: False ,
}
boolean ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource to which the managed private endpoint is created ,
Required: False ,
}
string ,
provisioningState:
{
Description: The managed private endpoint provisioning state ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
CredentialOperations_ListByFactory (removed)
Description :  List credentials.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials
{
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 credentials. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of credentials. ,
Required: True ,
}
{
type:
{
Description: Type of credential. ,
Required: True ,
}
string ,
description:
{
Description: Credential description. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the Credential. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
CredentialOperations_CreateOrUpdate (removed)
Description :  Creates or updates a credential.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}
{
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 ,
credentialName:
{
Description: Credential name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the credential entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
credential:
{
Description: Credential resource definition. ,
Required: True ,
}
{
properties:
{
Description: Properties of credentials. ,
Required: True ,
}
{
type:
{
Description: Type of credential. ,
Required: True ,
}
string ,
description:
{
Description: Credential description. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the Credential. ,
Required: False ,
}
[
object ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of credentials. ,
Required: True ,
}
{
type:
{
Description: Type of credential. ,
Required: True ,
}
string ,
description:
{
Description: Credential description. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the Credential. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
CredentialOperations_Get (removed)
Description :  Gets a credential.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}
{
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 ,
credentialName:
{
Description: Credential name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-None-Match:
{
Description: ETag of the credential entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of credentials. ,
Required: True ,
}
{
type:
{
Description: Type of credential. ,
Required: True ,
}
string ,
description:
{
Description: Credential description. ,
Required: False ,
}
string ,
annotations:
{
Description: List of tags that can be used for describing the Credential. ,
Required: False ,
}
[
object ,
]
,
}
,
}

⚐ Response (304)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
CredentialOperations_Delete (removed)
Description :  Deletes a credential.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}
{
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 ,
credentialName:
{
Description: Credential name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedPrivateEndpoints_CreateOrUpdate (removed)
Description :  Creates or updates a managed private endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}
{
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 ,
managedVirtualNetworkName:
{
Description: Managed virtual network name ,
Required: True ,
}
string ,
managedPrivateEndpointName:
{
Description: Managed private endpoint name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the managed private endpoint entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
managedPrivateEndpoint:
{
Description: Managed private endpoint resource definition. ,
Required: True ,
}
{
properties:
{
Description: Managed private endpoint properties. ,
Required: True ,
}
{
connectionState:
{
Description: The managed private endpoint connection state ,
Required: False ,
}
{
actionsRequired:
{
Description: The actions required on the managed private endpoint ,
Required: False ,
}
string ,
description:
{
Description: The managed private endpoint description ,
Required: False ,
}
string ,
status:
{
Description: The approval status ,
Required: False ,
}
string ,
}
,
fqdns:
{
Description: Fully qualified domain names ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: The groupId to which the managed private endpoint is created ,
Required: False ,
}
string ,
isReserved:
{
Description: Denotes whether the managed private endpoint is reserved ,
Required: False ,
}
boolean ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource to which the managed private endpoint is created ,
Required: False ,
}
string ,
provisioningState:
{
Description: The managed private endpoint provisioning state ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Managed private endpoint properties. ,
Required: True ,
}
{
connectionState:
{
Description: The managed private endpoint connection state ,
Required: False ,
}
{
actionsRequired:
{
Description: The actions required on the managed private endpoint ,
Required: False ,
}
string ,
description:
{
Description: The managed private endpoint description ,
Required: False ,
}
string ,
status:
{
Description: The approval status ,
Required: False ,
}
string ,
}
,
fqdns:
{
Description: Fully qualified domain names ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: The groupId to which the managed private endpoint is created ,
Required: False ,
}
string ,
isReserved:
{
Description: Denotes whether the managed private endpoint is reserved ,
Required: False ,
}
boolean ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource to which the managed private endpoint is created ,
Required: False ,
}
string ,
provisioningState:
{
Description: The managed private endpoint provisioning state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedPrivateEndpoints_Get (removed)
Description :  Gets a managed private endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}
{
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 ,
managedVirtualNetworkName:
{
Description: Managed virtual network name ,
Required: True ,
}
string ,
managedPrivateEndpointName:
{
Description: Managed private endpoint name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-None-Match:
{
Description: ETag of the managed private endpoint entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Managed private endpoint properties. ,
Required: True ,
}
{
connectionState:
{
Description: The managed private endpoint connection state ,
Required: False ,
}
{
actionsRequired:
{
Description: The actions required on the managed private endpoint ,
Required: False ,
}
string ,
description:
{
Description: The managed private endpoint description ,
Required: False ,
}
string ,
status:
{
Description: The approval status ,
Required: False ,
}
string ,
}
,
fqdns:
{
Description: Fully qualified domain names ,
Required: False ,
}
[
string ,
]
,
groupId:
{
Description: The groupId to which the managed private endpoint is created ,
Required: False ,
}
string ,
isReserved:
{
Description: Denotes whether the managed private endpoint is reserved ,
Required: False ,
}
boolean ,
privateLinkResourceId:
{
Description: The ARM resource ID of the resource to which the managed private endpoint is created ,
Required: False ,
}
string ,
provisioningState:
{
Description: The managed private endpoint provisioning state ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ManagedPrivateEndpoints_Delete (removed)
Description :  Deletes a managed private endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}
{
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 ,
managedVirtualNetworkName:
{
Description: Managed virtual network name ,
Required: True ,
}
string ,
managedPrivateEndpointName:
{
Description: Managed private endpoint name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
privateEndPointConnections_ListByFactory (removed)
Description :  Lists Private endpoint connections
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndPointConnections
{
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 Private Endpoint Connections. ,
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: PrivateEndpoint of a remote private endpoint connection ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The state of a private link connection ,
Required: False ,
}
{
status:
{
Description: Status of a private link connection ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: ActionsRequired for a private link connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
PrivateEndpointConnection_CreateOrUpdate (removed)
Description :  Approves or rejects a private endpoint connection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the private endpoint connection entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
privateEndpointWrapper:
{
Required: True ,
}
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
privateLinkServiceConnectionState:
{
Description: The state of a private link connection ,
Required: False ,
}
{
status:
{
Description: Status of a private link connection ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: ActionsRequired for a private link connection ,
Required: False ,
}
string ,
}
,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: PrivateEndpoint of a remote private endpoint connection ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The state of a private link connection ,
Required: False ,
}
{
status:
{
Description: Status of a private link connection ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: ActionsRequired for a private link connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
PrivateEndpointConnection_Get (removed)
Description :  Gets a private endpoint connection
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-None-Match:
{
Description: ETag of the private endpoint connection entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
privateEndpoint:
{
Description: PrivateEndpoint of a remote private endpoint connection ,
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The state of a private link connection ,
Required: False ,
}
{
status:
{
Description: Status of a private link connection ,
Required: False ,
}
string ,
description:
{
Description: Description of a private link connection ,
Required: False ,
}
string ,
actionsRequired:
{
Description: ActionsRequired for a private link connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
PrivateEndpointConnection_Delete (removed)
Description :  Deletes a private endpoint connection
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
privateLinkResources_Get (removed)
Description :  Gets the private link resources
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateLinkResources
{
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:
{
Required: True ,
}
[
{
properties:
{
Description: Core resource properties ,
Required: False ,
}
{
groupId:
{
Description: GroupId of a private link resource ,
Required: False ,
}
string ,
requiredMembers:
{
Description: RequiredMembers of a private link resource ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: RequiredZoneNames of a private link resource ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
GlobalParameters_ListByFactory (removed)
Description :  Lists Global parameters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters
{
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 global parameters. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the global parameter. ,
Required: True ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
GlobalParameters_Get (removed)
Description :  Gets a Global parameter
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}
{
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 ,
globalParameterName:
{
Description: The global parameter name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the global parameter. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
GlobalParameters_CreateOrUpdate (removed)
Description :  Creates or updates a Global parameter
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}
{
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 ,
globalParameterName:
{
Description: The global parameter name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
default:
{
Description: Global parameter resource definition. ,
Required: True ,
}
{
properties:
{
Description: Properties of the global parameter. ,
Required: True ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the global parameter. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
GlobalParameters_Delete (removed)
Description :  Deletes a Global parameter
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}
{
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 ,
globalParameterName:
{
Description: The global parameter name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_ListByFactory (removed)
Description :  Lists all resources of type change data capture.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs
{
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: Lists all resources of type change data capture. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the change data capture. ,
Required: True ,
}
{
folder:
{
Description: The folder that this CDC is in. If not specified, CDC will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this CDC is in. ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the change data capture. ,
Required: False ,
}
string ,
sourceConnectionsInfo:
{
Description: List of sources connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
sourceEntities:
{
Description: List of source tables for a source connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
targetConnectionsInfo:
{
Description: List of target connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
targetEntities:
{
Description: List of source tables for a target connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
dataMapperMappings:
{
Description: List of table mappings. ,
Required: False ,
}
[
{
targetEntityName:
{
Description: Name of the target table ,
Required: False ,
}
string ,
sourceEntityName:
{
Description: Name of the source table ,
Required: False ,
}
string ,
sourceConnectionReference:
{
Description: The connection reference for the source connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attributeMappingInfo:
{
Description: This holds the user provided attribute mapping information. ,
Required: False ,
}
{
attributeMappings:
{
Description: List of attribute mappings. ,
Required: False ,
}
[
{
name:
{
Description: Name of the target column. ,
Required: False ,
}
string ,
type:
{
Description: Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'. ,
Enum:
{
Direct: No description available. ,
Derived: No description available. ,
Aggregate: No description available. ,
}
,
Required: False ,
}
enum ,
functionName:
{
Description: Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping. ,
Required: False ,
}
string ,
expression:
{
Description: Expression used for 'Aggregate' and 'Derived' type mapping. ,
Required: False ,
}
string ,
attributeReference:
{
Description: Reference of the source column used in the mapping. It is used for 'Direct' mapping type only. ,
Required: False ,
}
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
attributeReferences:
{
Description: List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
sourceDenormalizeInfo:
{
Description: This holds the source denormalization information used while joining multiple sources. ,
Required: False ,
}
object ,
}
,
]
,
relationships:
{
Description: List of relationship info among the tables. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
policy:
{
Description: CDC policy ,
Required: True ,
}
{
mode:
{
Description: Mode of running the CDC: batch vs continuous. ,
Required: False ,
}
string ,
recurrence:
{
Description: Defines the frequency and interval for running the CDC for batch mode. ,
Required: False ,
}
{
frequency:
{
Description: Frequency of period in terms of 'Hour', 'Minute' or 'Second'. ,
Enum:
{
Hour: No description available. ,
Minute: No description available. ,
Second: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Actual interval value as per chosen frequency. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
allowVNetOverride:
{
Description: A boolean to determine if the vnet configuration needs to be overwritten. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the CDC as to if it is running or stopped. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of results, if any remaining results exist. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_CreateOrUpdate (removed)
Description :  Creates or updates a change data capture resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}
{
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 ,
changeDataCaptureName:
{
Description: The change data capture name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the change data capture entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. ,
Required: False ,
}
string ,
changeDataCapture:
{
Description: Change data capture resource definition. ,
Required: True ,
}
{
properties:
{
Description: Properties of the change data capture. ,
Required: True ,
}
{
folder:
{
Description: The folder that this CDC is in. If not specified, CDC will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this CDC is in. ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the change data capture. ,
Required: False ,
}
string ,
sourceConnectionsInfo:
{
Description: List of sources connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
sourceEntities:
{
Description: List of source tables for a source connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
targetConnectionsInfo:
{
Description: List of target connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
targetEntities:
{
Description: List of source tables for a target connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
dataMapperMappings:
{
Description: List of table mappings. ,
Required: False ,
}
[
{
targetEntityName:
{
Description: Name of the target table ,
Required: False ,
}
string ,
sourceEntityName:
{
Description: Name of the source table ,
Required: False ,
}
string ,
sourceConnectionReference:
{
Description: The connection reference for the source connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attributeMappingInfo:
{
Description: This holds the user provided attribute mapping information. ,
Required: False ,
}
{
attributeMappings:
{
Description: List of attribute mappings. ,
Required: False ,
}
[
{
name:
{
Description: Name of the target column. ,
Required: False ,
}
string ,
type:
{
Description: Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'. ,
Enum:
{
Direct: No description available. ,
Derived: No description available. ,
Aggregate: No description available. ,
}
,
Required: False ,
}
enum ,
functionName:
{
Description: Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping. ,
Required: False ,
}
string ,
expression:
{
Description: Expression used for 'Aggregate' and 'Derived' type mapping. ,
Required: False ,
}
string ,
attributeReference:
{
Description: Reference of the source column used in the mapping. It is used for 'Direct' mapping type only. ,
Required: False ,
}
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
attributeReferences:
{
Description: List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
sourceDenormalizeInfo:
{
Description: This holds the source denormalization information used while joining multiple sources. ,
Required: False ,
}
object ,
}
,
]
,
relationships:
{
Description: List of relationship info among the tables. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
policy:
{
Description: CDC policy ,
Required: True ,
}
{
mode:
{
Description: Mode of running the CDC: batch vs continuous. ,
Required: False ,
}
string ,
recurrence:
{
Description: Defines the frequency and interval for running the CDC for batch mode. ,
Required: False ,
}
{
frequency:
{
Description: Frequency of period in terms of 'Hour', 'Minute' or 'Second'. ,
Enum:
{
Hour: No description available. ,
Minute: No description available. ,
Second: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Actual interval value as per chosen frequency. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
allowVNetOverride:
{
Description: A boolean to determine if the vnet configuration needs to be overwritten. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the CDC as to if it is running or stopped. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the change data capture. ,
Required: True ,
}
{
folder:
{
Description: The folder that this CDC is in. If not specified, CDC will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this CDC is in. ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the change data capture. ,
Required: False ,
}
string ,
sourceConnectionsInfo:
{
Description: List of sources connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
sourceEntities:
{
Description: List of source tables for a source connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
targetConnectionsInfo:
{
Description: List of target connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
targetEntities:
{
Description: List of source tables for a target connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
dataMapperMappings:
{
Description: List of table mappings. ,
Required: False ,
}
[
{
targetEntityName:
{
Description: Name of the target table ,
Required: False ,
}
string ,
sourceEntityName:
{
Description: Name of the source table ,
Required: False ,
}
string ,
sourceConnectionReference:
{
Description: The connection reference for the source connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attributeMappingInfo:
{
Description: This holds the user provided attribute mapping information. ,
Required: False ,
}
{
attributeMappings:
{
Description: List of attribute mappings. ,
Required: False ,
}
[
{
name:
{
Description: Name of the target column. ,
Required: False ,
}
string ,
type:
{
Description: Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'. ,
Enum:
{
Direct: No description available. ,
Derived: No description available. ,
Aggregate: No description available. ,
}
,
Required: False ,
}
enum ,
functionName:
{
Description: Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping. ,
Required: False ,
}
string ,
expression:
{
Description: Expression used for 'Aggregate' and 'Derived' type mapping. ,
Required: False ,
}
string ,
attributeReference:
{
Description: Reference of the source column used in the mapping. It is used for 'Direct' mapping type only. ,
Required: False ,
}
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
attributeReferences:
{
Description: List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
sourceDenormalizeInfo:
{
Description: This holds the source denormalization information used while joining multiple sources. ,
Required: False ,
}
object ,
}
,
]
,
relationships:
{
Description: List of relationship info among the tables. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
policy:
{
Description: CDC policy ,
Required: True ,
}
{
mode:
{
Description: Mode of running the CDC: batch vs continuous. ,
Required: False ,
}
string ,
recurrence:
{
Description: Defines the frequency and interval for running the CDC for batch mode. ,
Required: False ,
}
{
frequency:
{
Description: Frequency of period in terms of 'Hour', 'Minute' or 'Second'. ,
Enum:
{
Hour: No description available. ,
Minute: No description available. ,
Second: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Actual interval value as per chosen frequency. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
allowVNetOverride:
{
Description: A boolean to determine if the vnet configuration needs to be overwritten. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the CDC as to if it is running or stopped. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_Get (removed)
Description :  Gets a change data capture.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}
{
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 ,
changeDataCaptureName:
{
Description: The change data capture name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
If-None-Match:
{
Description: ETag of the change data capture entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the change data capture. ,
Required: True ,
}
{
folder:
{
Description: The folder that this CDC is in. If not specified, CDC will appear at the root level. ,
Required: False ,
}
{
name:
{
Description: The name of the folder that this CDC is in. ,
Required: False ,
}
string ,
}
,
description:
{
Description: The description of the change data capture. ,
Required: False ,
}
string ,
sourceConnectionsInfo:
{
Description: List of sources connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
sourceEntities:
{
Description: List of source tables for a source connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
targetConnectionsInfo:
{
Description: List of target connections that can be used as sources in the CDC. ,
Required: True ,
}
[
{
targetEntities:
{
Description: List of source tables for a target connection. ,
Required: False ,
}
[
{
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
properties:
{
Description: Table properties. ,
Required: False ,
}
{
schema:
{
Description: List of columns for the source table. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
dslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
connection:
{
Description: Source connection details. ,
Required: False ,
}
{
linkedService:
{
Description: Linked service reference. ,
Required: False ,
}
{
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 ,
}
,
linkedServiceType:
{
Description: Type of the linked service e.g.: AzureBlobFS. ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: True ,
}
enum ,
isInlineDataset:
{
Description: A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. ,
Required: False ,
}
boolean ,
commonDslConnectorProperties:
{
Description: List of name/value pairs for connection properties. ,
Required: False ,
}
[
{
name:
{
Description: Name of the property. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. ,
Required: False ,
}
object ,
}
,
]
,
}
,
dataMapperMappings:
{
Description: List of table mappings. ,
Required: False ,
}
[
{
targetEntityName:
{
Description: Name of the target table ,
Required: False ,
}
string ,
sourceEntityName:
{
Description: Name of the source table ,
Required: False ,
}
string ,
sourceConnectionReference:
{
Description: The connection reference for the source connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attributeMappingInfo:
{
Description: This holds the user provided attribute mapping information. ,
Required: False ,
}
{
attributeMappings:
{
Description: List of attribute mappings. ,
Required: False ,
}
[
{
name:
{
Description: Name of the target column. ,
Required: False ,
}
string ,
type:
{
Description: Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'. ,
Enum:
{
Direct: No description available. ,
Derived: No description available. ,
Aggregate: No description available. ,
}
,
Required: False ,
}
enum ,
functionName:
{
Description: Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping. ,
Required: False ,
}
string ,
expression:
{
Description: Expression used for 'Aggregate' and 'Derived' type mapping. ,
Required: False ,
}
string ,
attributeReference:
{
Description: Reference of the source column used in the mapping. It is used for 'Direct' mapping type only. ,
Required: False ,
}
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
attributeReferences:
{
Description: List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only. ,
Required: False ,
}
[
{
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
entity:
{
Description: Name of the table. ,
Required: False ,
}
string ,
entityConnectionReference:
{
Description: The connection reference for the connection. ,
Required: False ,
}
{
connectionName:
{
Description: Name of the connection ,
Required: False ,
}
string ,
type:
{
Description: Type of connection via linked service or dataset. ,
Enum:
{
linkedservicetype: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
}
,
sourceDenormalizeInfo:
{
Description: This holds the source denormalization information used while joining multiple sources. ,
Required: False ,
}
object ,
}
,
]
,
relationships:
{
Description: List of relationship info among the tables. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
policy:
{
Description: CDC policy ,
Required: True ,
}
{
mode:
{
Description: Mode of running the CDC: batch vs continuous. ,
Required: False ,
}
string ,
recurrence:
{
Description: Defines the frequency and interval for running the CDC for batch mode. ,
Required: False ,
}
{
frequency:
{
Description: Frequency of period in terms of 'Hour', 'Minute' or 'Second'. ,
Enum:
{
Hour: No description available. ,
Minute: No description available. ,
Second: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: Actual interval value as per chosen frequency. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
allowVNetOverride:
{
Description: A boolean to determine if the vnet configuration needs to be overwritten. ,
Required: False ,
}
boolean ,
status:
{
Description: Status of the CDC as to if it is running or stopped. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_Delete (removed)
Description :  Deletes a change data capture.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}
{
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 ,
changeDataCaptureName:
{
Description: The change data capture name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_Start (removed)
Description :  Starts a change data capture.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/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 ,
changeDataCaptureName:
{
Description: The change data capture name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_Stop (removed)
Description :  Stops a change data capture.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/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 ,
changeDataCaptureName:
{
Description: The change data capture name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}
ChangeDataCapture_Status (removed)
Description :  Gets the current status for the change data capture resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/adfcdcs/{changeDataCaptureName}/status
{
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 ,
changeDataCaptureName:
{
Description: The change data capture name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Current status of the change data capture resource. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error data ,
Required: True ,
}
{
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 ,
]
,
}
,
}