你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.DataFactory 工厂

项目
03/13/2024

Bicep 资源定义

可以使用面向以下操作部署工厂资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.DataFactory/factories 资源，请将以下 Bicep 添加到模板。

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

FactoryRepoConfiguration 对象

设置 type 属性以指定对象的类型。

对于 FactoryGitHubConfiguration，请使用：

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

对于 FactoryVSTSConfiguration，请使用：

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

属性值

factories

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：3-63 有效字符：字母数字和连字符。以字母数字开头和结尾。资源名称在 Azure 中必须是唯一的。
location	资源位置。	字符串
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
标识	工厂的托管服务标识。	FactoryIdentity
properties	工厂的属性。	FactoryProperties

FactoryIdentity

名称	说明	Value
type	标识类型。	“SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” (必需)
userAssignedIdentities	工厂的用户分配标识列表。	UserAssignedIdentitiesDefinitionSpecification

UserAssignedIdentitiesDefinitionSpecification

名称	说明	值
{customized property}		对于 Bicep，可以使用任何 () 函数。

FactoryProperties

名称	说明	值
加密	用于为工厂启用客户管理的密钥的属性。	EncryptionConfiguration
globalParameters	工厂参数列表。	GlobalParameterDefinitionSpecification
publicNetworkAccess	数据工厂是否允许公用网络访问。	'Disabled' 'Enabled'
purviewConfiguration	工厂的 Purview 信息。	PurviewConfiguration
repoConfiguration	工厂的 Git 存储库信息。	FactoryRepoConfiguration

EncryptionConfiguration

名称	说明	值
标识	用户分配的标识，用于对客户的密钥保管库进行身份验证。如果未提供，将使用托管服务标识。	CMKIdentityDefinition
keyName	Azure 中密钥的名称密钥保管库用作客户管理的密钥。	字符串 (必需)
keyVersion	用于 CMK 的密钥的版本。如果未提供，将使用最新版本。	字符串
vaultBaseUrl	用于 CMK 的 Azure 密钥保管库的 URL。	字符串 (必需)

CMKIdentityDefinition

名称	说明	值
userAssignedIdentity	要向客户的密钥保管库进行身份验证的用户分配标识的资源 ID。	字符串

GlobalParameterDefinitionSpecification

名称	说明	值
{customized property}		GlobalParameterSpecification

GlobalParameterSpecification

名称	说明	Value
type	全局参数类型。	'Array' “Bool” “Float” “Int” “Object” “String” (必需)
value	参数的值。	对于 Bicep，可以使用所需的任何 () function. ()

PurviewConfiguration

名称	说明	值
purviewResourceId	Purview 资源 ID。	字符串

FactoryRepoConfiguration

名称	说明	值
accountName	帐户名。	字符串 (必需)
collaborationBranch	协作分支。	字符串 (必需)
disablePublish	在 ADF 工作室中禁用手动发布操作，以便支持自动发布。	bool
lastCommitId	上次提交 ID。	字符串
repositoryName	存储库名称。	字符串 (必需)
rootFolder	根文件夹。	字符串 (必需)
类型	设置对象类型	FactoryGitHubConfiguration FactoryVSTSConfiguration (必需)

FactoryGitHubConfiguration

名称	说明	Value
type	存储库配置的类型。	需要“FactoryGitHubConfiguration” ()
clientId	GitHub 自带应用客户端 ID。	字符串
clientSecret	GitHub 自带应用客户端机密信息。	GitHubClientSecret
hostName	GitHub Enterprise 主机名。例如： `https://github.mydomain.com`	字符串

GitHubClientSecret

名称	说明	值
byoaSecretAkvUrl	自带应用客户端机密 AKV URL。	字符串
byoaSecretName	在 AKV 中自带应用客户端密码名称。	字符串

FactoryVstsConfiguration

名称	说明	Value
type	存储库配置的类型。	“FactoryVSTSConfiguration” (必需)
projectName	VSTS 项目名称。	字符串 (必需)
tenantId	VSTS 租户 ID。	字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
在 Azure 上部署体育分析体系结构	创建启用了 ADLS Gen 2 的 Azure 存储帐户，创建一个Azure 数据工厂实例，其中包含存储帐户的链接服务 (Azure SQL数据库（如果已部署) ），以及一个 Azure Databricks 实例。将为部署模板的用户的 AAD 标识和 ADF 实例的托管标识授予存储帐户上的存储 Blob 数据参与者角色。还有一些选项可用于部署 Azure 密钥保管库实例、Azure SQL数据库和 Azure 事件中心 (，用于流式处理用例) 。部署 Azure 密钥保管库时，将为部署模板的用户授予数据工厂托管标识和 AAD 标识密钥保管库机密用户角色。
FinOps 中心	此模板创建新的 FinOps 中心实例，包括 Data Lake 存储和数据工厂。
Azure 数据工厂可以实现更多功能 - 单击一次尝试Azure 数据工厂	此模板为从 Azure Blob 复制到另一个 Azure Blob 的复制活动创建数据工厂管道
创建数据工厂，从 Salesforce 复制到 Blob	此模板使用 Azure 数据工厂执行从 Salesforce 到 Azure Blob 的数据移动
使用 Azure 数据工厂进行大容量复制	此模板创建一个 V2 数据工厂，用于将数据批量复制到Azure SQL数据库到Azure SQL数据仓库。
创建 V2 数据工厂	此模板创建一个 V2 数据工厂，用于将数据从Azure Blob 存储中的文件夹复制到存储中的另一个文件夹。
(MySQL) 创建 V2 数据工厂	此模板创建一个 V2 数据工厂，用于将数据从Azure Blob 存储中的文件夹复制到Azure Database for MySQL中的表。
(PostGre) 创建 V2 数据工厂	此模板创建一个 V2 数据工厂，用于将数据从Azure Blob 存储中的文件夹复制到Azure Database for PostgreSQL中的表。
(SQL) 创建 V2 数据工厂	此模板创建一个 V2 数据工厂，用于将数据从Azure Blob 存储中的文件夹复制到Azure SQL数据库中的表中。
创建空数据工厂	此模板创建一个空的数据工厂
使用 Git 和托管 vnet 配置Azure 数据工厂	此模板使用 Git 配置和托管虚拟网络创建Azure 数据工厂。
(SQL 本地) 创建 V2 数据工厂	此模板创建一个 V2 数据工厂，用于将数据从本地SQL Server复制到 Azure Blob 存储
在 Azure 中预配 SSIS 运行时	此模板创建 V2 数据工厂，然后预配 Azure SSIS 集成运行时
(Spark) 创建 V2 数据工厂	此模板创建一个 V2 数据工厂，用于将数据从Azure Blob 存储中的文件夹复制到存储中的另一个文件夹。

ARM 模板资源定义

可以使用面向以下操作部署工厂资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.DataFactory/factories 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DataFactory/factories",
  "apiVersion": "2018-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "encryption": {
      "identity": {
        "userAssignedIdentity": "string"
      },
      "keyName": "string",
      "keyVersion": "string",
      "vaultBaseUrl": "string"
    },
    "globalParameters": {
      "{customized property}": {
        "type": "string",
        "value": {}
      }
    },
    "publicNetworkAccess": "string",
    "purviewConfiguration": {
      "purviewResourceId": "string"
    },
    "repoConfiguration": {
      "accountName": "string",
      "collaborationBranch": "string",
      "disablePublish": "bool",
      "lastCommitId": "string",
      "repositoryName": "string",
      "rootFolder": "string",
      "type": "string"
      // For remaining properties, see FactoryRepoConfiguration objects
    }
  }
}

FactoryRepoConfiguration 对象

设置 type 属性以指定对象的类型。

对于 FactoryGitHubConfiguration，请使用：

  "type": "FactoryGitHubConfiguration",
  "clientId": "string",
  "clientSecret": {
    "byoaSecretAkvUrl": "string",
    "byoaSecretName": "string"
  },
  "hostName": "string"

对于 FactoryVSTSConfiguration，请使用：

  "type": "FactoryVSTSConfiguration",
  "projectName": "string",
  "tenantId": "string"

属性值

factories

名称	说明	Value
type	资源类型	'Microsoft.DataFactory/factories'
apiVersion	资源 API 版本	'2018-06-01'
name	资源名称	字符串 (必需) 字符限制：3-63 有效字符：字母数字和连字符。以字母数字开头和结尾。资源名称在 Azure 中必须是唯一的。
location	资源位置。	字符串
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
标识	工厂的托管服务标识。	FactoryIdentity
properties	工厂的属性。	FactoryProperties

FactoryIdentity

名称	说明	Value
type	标识类型。	“SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” (必需)
userAssignedIdentities	工厂的用户分配标识列表。	UserAssignedIdentitiesDefinitionSpecification

UserAssignedIdentitiesDefinitionSpecification

名称	说明	值
{customized property}

FactoryProperties

名称	说明	值
加密	用于为工厂启用客户管理的密钥的属性。	EncryptionConfiguration
globalParameters	工厂的参数列表。	GlobalParameterDefinitionSpecification
publicNetworkAccess	数据工厂是否允许公用网络访问。	“Disabled” “已启用”
purviewConfiguration	工厂的 Purview 信息。	PurviewConfiguration
repoConfiguration	工厂的 Git 存储库信息。	FactoryRepoConfiguration

EncryptionConfiguration

名称	说明	值
标识	用户分配的标识用于向客户的密钥保管库进行身份验证。如果未提供托管服务标识，则将使用。	CMKIdentityDefinition
keyName	Azure 中要用作客户管理的密钥密钥保管库密钥的名称。	字符串 (必需)
keyVersion	用于 CMK 的密钥的版本。如果未提供，将使用最新版本。	字符串
vaultBaseUrl	用于 CMK 的 Azure 密钥保管库的 URL。	字符串 (必需)

CMKIdentityDefinition

名称	说明	值
userAssignedIdentity	要向客户的密钥保管库进行身份验证的用户分配标识的资源 ID。	字符串

GlobalParameterDefinitionSpecification

名称	说明	值
{customized property}		GlobalParameterSpecification

GlobalParameterSpecification

名称	说明	Value
type	全局参数类型。	“Array” “Bool” “Float” “Int” “Object” “String” (必需)
value	参数的值。

PurviewConfiguration

名称	说明	值
purviewResourceId	Purview 资源 ID。	字符串

FactoryRepoConfiguration

名称	说明	值
accountName	帐户名称。	字符串 (必需)
collaborationBranch	协作分支。	字符串 (必需)
disablePublish	在 ADF Studio 中禁用手动发布操作以支持自动发布。	bool
lastCommitId	上次提交 ID。	字符串
repositoryName	存储库名称。	字符串 (必需)
rootFolder	根文件夹。	字符串 (必需)
类型	设置对象类型	FactoryGitHubConfiguration FactoryVSTSConfiguration (必需)

FactoryGitHubConfiguration

名称	说明	Value
type	存储库配置的类型。	需要“FactoryGitHubConfiguration” ()
clientId	GitHub 自带应用客户端 ID。	字符串
clientSecret	GitHub 自带应用客户端机密信息。	GitHubClientSecret
hostName	GitHub Enterprise 主机名。例如： `https://github.mydomain.com`	字符串

GitHubClientSecret

名称	说明	值
byoaSecretAkvUrl	自带应用客户端机密 AKV URL。	字符串
byoaSecretName	在 AKV 中自带应用客户端密码名称。	字符串

FactoryVstsConfiguration

名称	说明	Value
type	存储库配置的类型。	“FactoryVSTSConfiguration” (必需)
projectName	VSTS 项目名称。	字符串 (必需)
tenantId	VSTS 租户 ID。	字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
在 Azure 上部署体育分析体系结构	创建启用了 ADLS Gen 2 的 Azure 存储帐户，创建一个Azure 数据工厂实例，其中包含存储帐户的链接服务 (Azure SQL数据库（如果已部署) ），以及一个 Azure Databricks 实例。将为部署模板的用户的 AAD 标识和 ADF 实例的托管标识授予存储帐户上的存储 Blob 数据参与者角色。还有一些选项可用于部署 Azure 密钥保管库实例、Azure SQL数据库和 Azure 事件中心 (，用于流式处理用例) 。部署 Azure 密钥保管库时，将为部署模板的用户授予数据工厂托管标识和 AAD 标识密钥保管库机密用户角色。
FinOps 中心	此模板创建新的 FinOps 中心实例，包括 Data Lake 存储和数据工厂。
Azure 数据工厂可以实现更多功能 - 单击一次尝试Azure 数据工厂	此模板为从 Azure Blob 复制到另一个 Azure Blob 的复制活动创建数据工厂管道
创建数据工厂，从 Salesforce 复制到 Blob	此模板使用 Azure 数据工厂执行从 Salesforce 到 Azure Blob 的数据移动
使用 Azure 数据工厂进行大容量复制	此模板创建一个 V2 数据工厂，用于将数据批量复制到Azure SQL数据库到Azure SQL数据仓库。
创建 V2 数据工厂	此模板创建一个 V2 数据工厂，用于将数据从Azure Blob 存储中的文件夹复制到存储中的另一个文件夹。
(MySQL) 创建 V2 数据工厂	此模板创建一个 V2 数据工厂，用于将数据从Azure Blob 存储中的文件夹复制到Azure Database for MySQL中的表。
(PostGre) 创建 V2 数据工厂	此模板创建一个 V2 数据工厂，用于将数据从Azure Blob 存储中的文件夹复制到Azure Database for PostgreSQL中的表。
(SQL) 创建 V2 数据工厂	此模板创建一个 V2 数据工厂，用于将数据从Azure Blob 存储中的文件夹复制到Azure SQL数据库中的表中。
创建空数据工厂	此模板创建一个空的数据工厂
使用 Git 和托管 vnet 配置Azure 数据工厂	此模板使用 Git 配置和托管虚拟网络创建Azure 数据工厂。
(SQL 本地) 创建 V2 数据工厂	此模板创建一个 V2 数据工厂，用于将数据从本地SQL Server复制到 Azure Blob 存储
在 Azure 中预配 SSIS 运行时	此模板创建 V2 数据工厂，然后预配 Azure SSIS 集成运行时
(Spark) 创建 V2 数据工厂	此模板创建一个 V2 数据工厂，用于将数据从Azure Blob 存储中的文件夹复制到存储中的另一个文件夹。

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署工厂资源类型：

资源组

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.DataFactory/factories 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories@2018-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      encryption = {
        identity = {
          userAssignedIdentity = "string"
        }
        keyName = "string"
        keyVersion = "string"
        vaultBaseUrl = "string"
      }
      globalParameters = {
        {customized property} = {
          type = "string"
        }
      }
      publicNetworkAccess = "string"
      purviewConfiguration = {
        purviewResourceId = "string"
      }
      repoConfiguration = {
        accountName = "string"
        collaborationBranch = "string"
        disablePublish = bool
        lastCommitId = "string"
        repositoryName = "string"
        rootFolder = "string"
        type = "string"
        // For remaining properties, see FactoryRepoConfiguration objects
      }
    }
  })
}

FactoryRepoConfiguration 对象

设置 type 属性以指定对象的类型。

对于 FactoryGitHubConfiguration，请使用：

  type = "FactoryGitHubConfiguration"
  clientId = "string"
  clientSecret = {
    byoaSecretAkvUrl = "string"
    byoaSecretName = "string"
  }
  hostName = "string"

对于 FactoryVSTSConfiguration，请使用：

  type = "FactoryVSTSConfiguration"
  projectName = "string"
  tenantId = "string"

属性值

factories

名称	说明	Value
type	资源类型	“Microsoft.DataFactory/factories@2018-06-01”
name	资源名称	字符串 (必需) 字符限制：3-63 有效字符：字母数字和连字符。以字母数字开头和结尾。资源名称在 Azure 中必须是唯一的。
location	资源位置。	字符串
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。
标识	工厂的托管服务标识。	FactoryIdentity
properties	工厂的属性。	FactoryProperties

FactoryIdentity

名称	说明	Value
type	标识类型。	“SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” (必需)
identity_ids	工厂的用户分配标识列表。	用户标识 ID 数组。

UserAssignedIdentitiesDefinitionSpecification

名称	说明	值
{customized property}

FactoryProperties

名称	说明	值
加密	用于为工厂启用客户管理的密钥的属性。	EncryptionConfiguration
globalParameters	工厂的参数列表。	GlobalParameterDefinitionSpecification
publicNetworkAccess	数据工厂是否允许公用网络访问。	“Disabled” “已启用”
purviewConfiguration	工厂的 Purview 信息。	PurviewConfiguration
repoConfiguration	工厂的 Git 存储库信息。	FactoryRepoConfiguration

EncryptionConfiguration

名称	说明	值
标识	用户分配的标识用于向客户的密钥保管库进行身份验证。如果未提供托管服务标识，则将使用。	CMKIdentityDefinition
keyName	Azure 中要用作客户管理的密钥密钥保管库密钥的名称。	字符串 (必需)
keyVersion	用于 CMK 的密钥的版本。如果未提供，将使用最新版本。	字符串
vaultBaseUrl	用于 CMK 的 Azure 密钥保管库的 URL。	字符串 (必需)

CMKIdentityDefinition

名称	说明	值
userAssignedIdentity	要向客户的密钥保管库进行身份验证的用户分配标识的资源 ID。	字符串

GlobalParameterDefinitionSpecification

名称	说明	值
{customized property}		GlobalParameterSpecification

GlobalParameterSpecification

名称	说明	Value
type	全局参数类型。	“Array” “Bool” “Float” “Int” “Object” “字符串” (必需)
value	参数的值。

PurviewConfiguration

名称	说明	值
purviewResourceId	Purview 资源 ID。	字符串

FactoryRepoConfiguration

名称	说明	值
accountName	帐户名。	字符串 (必需)
collaborationBranch	协作分支。	字符串 (必需)
disablePublish	在 ADF 工作室中禁用手动发布操作，以便支持自动发布。	bool
lastCommitId	上次提交 ID。	字符串
repositoryName	存储库名称。	字符串 (必需)
rootFolder	根文件夹。	字符串 (必需)
类型	设置对象类型	FactoryGitHubConfiguration FactoryVSTSConfiguration (必需)

FactoryGitHubConfiguration

名称	说明	Value
type	存储库配置的类型。	“FactoryGitHubConfiguration” (必需)
clientId	GitHub 自带应用客户端 ID。	字符串
clientSecret	GitHub 自带应用客户端机密信息。	GitHubClientSecret
hostName	GitHub Enterprise 主机名。例如： `https://github.mydomain.com`	字符串

GitHubClientSecret

名称	说明	值
byoaSecretAkvUrl	自带应用客户端机密 AKV URL。	字符串
byoaSecretName	在 AKV 中自带应用客户端密码名称。	字符串

FactoryVstsConfiguration

名称	说明	Value
type	存储库配置的类型。	“FactoryVSTSConfiguration” (必需)
projectName	VSTS 项目名称。	字符串 (必需)
tenantId	VSTS 租户 ID。	字符串

Microsoft.DataFactory 工厂

Bicep 资源定义

资源格式

FactoryRepoConfiguration 对象

属性值

factories

FactoryIdentity

UserAssignedIdentitiesDefinitionSpecification

FactoryProperties

EncryptionConfiguration

CMKIdentityDefinition

GlobalParameterDefinitionSpecification

GlobalParameterSpecification

PurviewConfiguration

FactoryRepoConfiguration

FactoryGitHubConfiguration

GitHubClientSecret

FactoryVstsConfiguration

快速入门模板

ARM 模板资源定义

资源格式

FactoryRepoConfiguration 对象

属性值

factories

FactoryIdentity

UserAssignedIdentitiesDefinitionSpecification

FactoryProperties

EncryptionConfiguration

CMKIdentityDefinition

GlobalParameterDefinitionSpecification

GlobalParameterSpecification

PurviewConfiguration

FactoryRepoConfiguration

FactoryGitHubConfiguration

GitHubClientSecret

FactoryVstsConfiguration

快速入门模板

Terraform (AzAPI 提供程序) 资源定义

资源格式

FactoryRepoConfiguration 对象

属性值

factories

FactoryIdentity

UserAssignedIdentitiesDefinitionSpecification

FactoryProperties

EncryptionConfiguration

CMKIdentityDefinition

GlobalParameterDefinitionSpecification

GlobalParameterSpecification

PurviewConfiguration

FactoryRepoConfiguration

FactoryGitHubConfiguration

GitHubClientSecret

FactoryVstsConfiguration

反馈

反馈

其他资源