Microsoft.DataFactory factories 2017-09-01-preview
Bicep resource definition
The factories resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DataFactory/factories resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DataFactory/factories@2017-09-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'SystemAssigned'
}
properties: {
vstsConfiguration: {
accountName: 'string'
collaborationBranch: 'string'
lastCommitId: 'string'
projectName: 'string'
repositoryName: 'string'
rootFolder: 'string'
tenantId: 'string'
}
}
}
Property values
factories
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 3-63 Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric. Resource name must be unique across Azure. |
| location | The resource location. | string |
| tags | The resource tags. | Dictionary of tag names and values. See Tags in templates |
| identity | Managed service identity of the factory. | FactoryIdentity |
| properties | Properties of the factory. | FactoryProperties |
FactoryIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. Currently the only supported type is 'SystemAssigned'. | 'SystemAssigned' (required) |
FactoryProperties
| Name | Description | Value |
|---|---|---|
| vstsConfiguration | VSTS repo information of the factory. | FactoryVstsConfiguration |
FactoryVstsConfiguration
| Name | Description | Value |
|---|---|---|
| accountName | VSTS account name. | string |
| collaborationBranch | VSTS collaboration branch. | string |
| lastCommitId | VSTS last commit id. | string |
| projectName | VSTS project name. | string |
| repositoryName | VSTS repository name. | string |
| rootFolder | VSTS root folder. | string |
| tenantId | VSTS tenant id. | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Deploy the Sports Analytics on Azure Architecture |
Creates an Azure storage account with ADLS Gen 2 enabled, an Azure Data Factory instance with linked services for the storage account (an the Azure SQL Database if deployed), and an Azure Databricks instance. The AAD identity for the user deploying the template and the managed identity for the ADF instance will be granted the Storage Blob Data Contributor role on the storage account. There are also options to deploy an Azure Key Vault instance, an Azure SQL Database, and an Azure Event Hub (for streaming use cases). When an Azure Key Vault is deployed, the data factory managed identity and the AAD identity for the user deploying the template will be granted the Key Vault Secrets User role. |
| FinOps hub |
This template creates a new FinOps hub instance, including Data Lake storage and a Data Factory. |
| More is possible with Azure Data Factory - One click to try Azure Data Factory |
This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob |
| Create a Data Factory, copy from Salesforce to Blob |
This template uses Azure Data Factory to perform data movement from Salesforce to Azure Blobs |
| Bulk copy using Azure Data Factory |
This template creates a V2 data factory that copies data in bulk an Azure SQL database to an Azure SQL data warehouse. |
| Create a V2 data factory |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage. |
| Create a V2 data factory (MySQL) |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for MySQL. |
| Create a V2 data factory (PostGre) |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for PostgreSQL. |
| Create a V2 data factory (SQL) |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure SQL database. |
| Create an empty data factory |
This template creates an empty data factory |
| Azure Data Factory with Git and managed vnet configuration |
This template creates Azure Data Factory with Git configuration and managed virtual network. |
| Create a V2 data factory (SQL On-prem) |
This template creates a V2 data factory that copies data from an on-premises SQL Server to an Azure blob storage |
| Provision SSIS runtime in Azure |
This template creates a V2 data factory and then provisions an Azure SSIS integration runtime |
| Create a V2 data factory (Spark) |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage. |
ARM template resource definition
The factories resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DataFactory/factories resource, add the following JSON to your template.
{
"type": "Microsoft.DataFactory/factories",
"apiVersion": "2017-09-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "SystemAssigned"
},
"properties": {
"vstsConfiguration": {
"accountName": "string",
"collaborationBranch": "string",
"lastCommitId": "string",
"projectName": "string",
"repositoryName": "string",
"rootFolder": "string",
"tenantId": "string"
}
}
}
Property values
factories
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.DataFactory/factories' |
| apiVersion | The resource api version | '2017-09-01-preview' |
| name | The resource name | string (required) Character limit: 3-63 Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric. Resource name must be unique across Azure. |
| location | The resource location. | string |
| tags | The resource tags. | Dictionary of tag names and values. See Tags in templates |
| identity | Managed service identity of the factory. | FactoryIdentity |
| properties | Properties of the factory. | FactoryProperties |
FactoryIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. Currently the only supported type is 'SystemAssigned'. | 'SystemAssigned' (required) |
FactoryProperties
| Name | Description | Value |
|---|---|---|
| vstsConfiguration | VSTS repo information of the factory. | FactoryVstsConfiguration |
FactoryVstsConfiguration
| Name | Description | Value |
|---|---|---|
| accountName | VSTS account name. | string |
| collaborationBranch | VSTS collaboration branch. | string |
| lastCommitId | VSTS last commit id. | string |
| projectName | VSTS project name. | string |
| repositoryName | VSTS repository name. | string |
| rootFolder | VSTS root folder. | string |
| tenantId | VSTS tenant id. | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Deploy the Sports Analytics on Azure Architecture |
Creates an Azure storage account with ADLS Gen 2 enabled, an Azure Data Factory instance with linked services for the storage account (an the Azure SQL Database if deployed), and an Azure Databricks instance. The AAD identity for the user deploying the template and the managed identity for the ADF instance will be granted the Storage Blob Data Contributor role on the storage account. There are also options to deploy an Azure Key Vault instance, an Azure SQL Database, and an Azure Event Hub (for streaming use cases). When an Azure Key Vault is deployed, the data factory managed identity and the AAD identity for the user deploying the template will be granted the Key Vault Secrets User role. |
| FinOps hub |
This template creates a new FinOps hub instance, including Data Lake storage and a Data Factory. |
| More is possible with Azure Data Factory - One click to try Azure Data Factory |
This template creates a data factory pipeline for a copy activity from Azure Blob into another Azure Blob |
| Create a Data Factory, copy from Salesforce to Blob |
This template uses Azure Data Factory to perform data movement from Salesforce to Azure Blobs |
| Bulk copy using Azure Data Factory |
This template creates a V2 data factory that copies data in bulk an Azure SQL database to an Azure SQL data warehouse. |
| Create a V2 data factory |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage. |
| Create a V2 data factory (MySQL) |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for MySQL. |
| Create a V2 data factory (PostGre) |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure Database for PostgreSQL. |
| Create a V2 data factory (SQL) |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to a table in an Azure SQL database. |
| Create an empty data factory |
This template creates an empty data factory |
| Azure Data Factory with Git and managed vnet configuration |
This template creates Azure Data Factory with Git configuration and managed virtual network. |
| Create a V2 data factory (SQL On-prem) |
This template creates a V2 data factory that copies data from an on-premises SQL Server to an Azure blob storage |
| Provision SSIS runtime in Azure |
This template creates a V2 data factory and then provisions an Azure SSIS integration runtime |
| Create a V2 data factory (Spark) |
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage. |
Terraform (AzAPI provider) resource definition
The factories resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DataFactory/factories resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DataFactory/factories@2017-09-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
vstsConfiguration = {
accountName = "string"
collaborationBranch = "string"
lastCommitId = "string"
projectName = "string"
repositoryName = "string"
rootFolder = "string"
tenantId = "string"
}
}
})
}
Property values
factories
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.DataFactory/factories@2017-09-01-preview" |
| name | The resource name | string (required) Character limit: 3-63 Valid characters: Alphanumerics and hyphens. Start and end with alphanumeric. Resource name must be unique across Azure. |
| location | The resource location. | string |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | The resource tags. | Dictionary of tag names and values. |
| identity | Managed service identity of the factory. | FactoryIdentity |
| properties | Properties of the factory. | FactoryProperties |
FactoryIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. Currently the only supported type is 'SystemAssigned'. | "SystemAssigned" (required) |
FactoryProperties
| Name | Description | Value |
|---|---|---|
| vstsConfiguration | VSTS repo information of the factory. | FactoryVstsConfiguration |
FactoryVstsConfiguration
| Name | Description | Value |
|---|---|---|
| accountName | VSTS account name. | string |
| collaborationBranch | VSTS collaboration branch. | string |
| lastCommitId | VSTS last commit id. | string |
| projectName | VSTS project name. | string |
| repositoryName | VSTS repository name. | string |
| rootFolder | VSTS root folder. | string |
| tenantId | VSTS tenant id. | string |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for