Microsoft.DataFactory factories 2018-06-01

The factories resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.DataFactory/factories resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.DataFactory/factories@2018-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    encryption: {
      identity: {
        userAssignedIdentity: 'string'
      }
      keyName: 'string'
      keyVersion: 'string'
      vaultBaseUrl: 'string'
    }
    globalParameters: {}
    publicNetworkAccess: 'string'
    repoConfiguration: {
      accountName: 'string'
      collaborationBranch: 'string'
      lastCommitId: 'string'
      repositoryName: 'string'
      rootFolder: 'string'
      type: 'string'
      // For remaining properties, see FactoryRepoConfiguration objects
    }
  }
}

FactoryRepoConfiguration objects

Set the type property to specify the type of object.

For FactoryGitHubConfiguration, use:

  type: 'FactoryGitHubConfiguration'
  clientId: 'string'
  clientSecret: {
    byoaSecretAkvUrl: 'string'
    byoaSecretName: 'string'
  }
  hostName: 'string'

For FactoryVSTSConfiguration, use:

  type: 'FactoryVSTSConfiguration'
  projectName: 'string'
  tenantId: 'string'

Property values

factories

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.DataFactory/factories'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2018-06-01'
name The resource name string (required)
location The resource location. string
tags The resource tags. Dictionary of tag names and values. See Tags in templates
identity Identity properties of the factory resource. FactoryIdentity
properties Factory resource properties. FactoryProperties

FactoryIdentity

Name Description Value
type The identity type. 'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Definition of all user assigned identities for a factory. object

FactoryProperties

Name Description Value
encryption Definition of CMK for the factory. EncryptionConfiguration
globalParameters Definition of all parameters for an entity. object
publicNetworkAccess Whether or not public network access is allowed for the data factory. 'Disabled'
'Enabled'
repoConfiguration Factory's git repo information. FactoryRepoConfiguration

EncryptionConfiguration

Name Description Value
identity Managed Identity used for CMK. CMKIdentityDefinition
keyName The name of the key in Azure Key Vault to use as Customer Managed Key. string (required)
keyVersion The version of the key used for CMK. If not provided, latest version will be used. string
vaultBaseUrl The url of the Azure Key Vault used for CMK. string (required)

CMKIdentityDefinition

Name Description Value
userAssignedIdentity The resource id of the user assigned identity to authenticate to customer's key vault. string

FactoryRepoConfiguration

Name Description Value
accountName Account name. string (required)
collaborationBranch Collaboration branch. string (required)
lastCommitId Last commit id. string
repositoryName Repository name. string (required)
rootFolder Root folder. string (required)
type Set the object type FactoryGitHubConfiguration
FactoryVSTSConfiguration

FactoryGitHubConfiguration

Name Description Value
type Type of repo configuration. 'FactoryGitHubConfiguration'
clientId GitHub bring your own app client id. string
clientSecret Client secret information for factory's bring your own app repository configuration. GitHubClientSecret
hostName GitHub Enterprise host name. For example: https://github.mydomain.com string

GitHubClientSecret

Name Description Value
byoaSecretAkvUrl Bring your own app client secret AKV URL. string
byoaSecretName Bring your own app client secret name in AKV. string

FactoryVstsConfiguration

Name Description Value
type Type of repo configuration. 'FactoryVSTSConfiguration'
projectName VSTS project name. string (required)
tenantId VSTS tenant id. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a Data Factory, copy from Salesforce to Blob

Deploy to Azure
This template uses Azure Data Factory to perform data movement from Salesforce to Azure Blobs
Bulk copy using Azure Data Factory

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
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

Deploy to Azure
This template creates an empty data factory
Create a V2 data factory

Deploy to Azure
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

Deploy to Azure
This template creates a V2 data factory and then provisions an Azure SSIS integration runtime
Create a V2 data factory

Deploy to Azure
This template creates a V2 data factory that copies data from a folder in an Azure Blob Storage to another folder in the storage.