Microsoft.DataFactory/factories

Bicep 资源定义

工厂资源类型可以使用目标操作进行部署：

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

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

资源格式

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

resource symbolicname 'Microsoft.DataFactory/factories@2018-06-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    encryption: {
      identity: {
        userAssignedIdentity: 'string'
      }
      keyName: 'string'
      keyVersion: 'string'
      vaultBaseUrl: 'string'
    }
    globalParameters: {
      {customized property}: {
        type: 'string'
        value: any(Azure.Bicep.Types.Concrete.AnyType)
      }
    }
    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
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

FactoryRepoConfiguration 对象

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

对于 FactoryGitHubConfiguration，请使用：

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

对于 FactoryVSTSConfiguration，请使用：

{
  projectName: 'string'
  tenantId: 'string'
  type: 'FactoryVSTSConfiguration'
}

属性值

CMKIdentityDefinition

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

EncryptionConfiguration

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

FactoryGitHubConfiguration

名字	描述	价值
clientId	GitHub 自带应用客户端 ID。	字符串
clientSecret	GitHub 自带应用客户端机密信息。	GitHubClientSecret
hostName	GitHub Enterprise 主机名。例如：`https://github.mydomain.com`	字符串
类型	存储库配置的类型。	“FactoryGitHubConfiguration”（必需）

FactoryIdentity

名字	描述	价值
类型	标识类型。	“SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”（必需）
userAssignedIdentities	工厂的用户分配标识列表。	UserAssignedIdentitiesDefinitionSpecification

FactoryProperties

名字	描述	价值
加密	为工厂启用客户管理的密钥的属性。	EncryptionConfiguration
globalParameters	工厂的参数列表。	GlobalParameterDefinitionSpecification
publicNetworkAccess	是否允许对数据工厂进行公用网络访问。	“Disabled” “Enabled”
purviewConfiguration	工厂的 Purview 信息。	PurviewConfiguration
repoConfiguration	工厂的 Git 存储库信息。	FactoryRepoConfiguration

FactoryRepoConfiguration

名字	描述	价值
accountName	帐户名称。	string （必需）
collaborationBranch	协作分支。	string （必需）
disablePublish	在 ADF Studio 中禁用手动发布操作，以支持自动发布。	bool
lastCommitId	上次提交 ID。	字符串
repositoryName	存储库名称。	string （必需）
rootFolder	根文件夹。	string （必需）
类型	对于 FactoryGitHubConfiguration类型，设置为“FactoryGitHubConfiguration”。对于 factoryVstsConfiguration类型，设置为“FactoryVSTSConfiguration”。	“FactoryGitHubConfiguration” “FactoryVSTSConfiguration”（必需）

FactoryVstsConfiguration

名字	描述	价值
projectName	VSTS 项目名称。	string （必需）
tenantId	VSTS 租户 ID。	字符串
类型	存储库配置的类型。	“FactoryVSTSConfiguration”（必需）

GitHubClientSecret

名字	描述	价值
byoaSecretAkvUrl	自带应用客户端机密 AKV URL。	字符串
byoaSecretName	在 AKV 中自带应用客户端机密名称。	字符串

GlobalParameterDefinitionSpecification

名字	描述	价值

GlobalParameterSpecification

名字	描述	价值
类型	全局参数类型。	“Array” “Bool” “Float” “Int” “Object” “String”（必需）
价值	参数的值。	任何（必需）

名字	描述	价值
身份	工厂的托管服务标识。	FactoryIdentity
位置	资源位置。	字符串
名字	资源名称	字符串约束：最小长度 = 3 最大长度 = 3 模式 = `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$` （必需）
性能	工厂的属性。	FactoryProperties
标签	资源标记	标记名称和值的字典。请参阅模板中的标记

PurviewConfiguration

名字	描述	价值
purviewResourceId	Purview 资源 ID。	字符串

ResourceTags

名字	描述	价值

UserAssignedIdentitiesDefinitionSpecification

名字	描述	价值

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
使用 Git 和托管 vnet 配置 Azure 数据工厂	此模板使用 Git 配置和托管虚拟网络创建 Azure 数据工厂。
创建 V2 数据工厂	此模板创建一个 V2 数据工厂，用于将数据从 Azure Blob 存储中的文件夹复制到存储中的另一个文件夹。
创建空数据工厂	此模板创建空数据工厂
在 Azure 体系结构上部署体育分析	创建启用了 ADLS Gen 2 的 Azure 存储帐户、存储帐户的链接服务的 Azure 数据工厂实例（如果已部署的 Azure SQL 数据库）和 Azure Databricks 实例。将为部署模板的用户的 AAD 标识以及 ADF 实例的托管标识授予存储帐户上的存储 Blob 数据参与者角色。还有一些选项可用于部署 Azure Key Vault 实例、Azure SQL 数据库和 Azure 事件中心（用于流式处理用例）。部署 Azure Key Vault 后，将为部署模板的用户提供数据工厂托管标识和 AAD 标识，并被授予 Key Vault 机密用户角色。
FinOps 中心	此模板创建新的 FinOps 中心实例，包括 Data Lake 存储和数据工厂。
可以使用 Azure 数据工厂更多 - 单击一次尝试 Azure 数据工厂	此模板为从 Azure Blob 复制到另一个 Azure Blob 中的复制活动创建数据工厂管道

ARM 模板资源定义

工厂资源类型可以使用目标操作进行部署：

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

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

资源格式

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

{
  "type": "Microsoft.DataFactory/factories",
  "apiVersion": "2018-06-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "location": "string",
  "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
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

FactoryRepoConfiguration 对象

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

对于 FactoryGitHubConfiguration，请使用：

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

对于 FactoryVSTSConfiguration，请使用：

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

属性值

CMKIdentityDefinition

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

EncryptionConfiguration

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

FactoryGitHubConfiguration

名字	描述	价值
clientId	GitHub 自带应用客户端 ID。	字符串
clientSecret	GitHub 自带应用客户端机密信息。	GitHubClientSecret
hostName	GitHub Enterprise 主机名。例如：`https://github.mydomain.com`	字符串
类型	存储库配置的类型。	“FactoryGitHubConfiguration”（必需）

FactoryIdentity

名字	描述	价值
类型	标识类型。	“SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”（必需）
userAssignedIdentities	工厂的用户分配标识列表。	UserAssignedIdentitiesDefinitionSpecification

FactoryProperties

名字	描述	价值
加密	为工厂启用客户管理的密钥的属性。	EncryptionConfiguration
globalParameters	工厂的参数列表。	GlobalParameterDefinitionSpecification
publicNetworkAccess	是否允许对数据工厂进行公用网络访问。	“Disabled” “Enabled”
purviewConfiguration	工厂的 Purview 信息。	PurviewConfiguration
repoConfiguration	工厂的 Git 存储库信息。	FactoryRepoConfiguration

FactoryRepoConfiguration

名字	描述	价值
accountName	帐户名称。	string （必需）
collaborationBranch	协作分支。	string （必需）
disablePublish	在 ADF Studio 中禁用手动发布操作，以支持自动发布。	bool
lastCommitId	上次提交 ID。	字符串
repositoryName	存储库名称。	string （必需）
rootFolder	根文件夹。	string （必需）
类型	对于 FactoryGitHubConfiguration类型，设置为“FactoryGitHubConfiguration”。对于 factoryVstsConfiguration类型，设置为“FactoryVSTSConfiguration”。	“FactoryGitHubConfiguration” “FactoryVSTSConfiguration”（必需）

FactoryVstsConfiguration

名字	描述	价值
projectName	VSTS 项目名称。	string （必需）
tenantId	VSTS 租户 ID。	字符串
类型	存储库配置的类型。	“FactoryVSTSConfiguration”（必需）

GitHubClientSecret

名字	描述	价值
byoaSecretAkvUrl	自带应用客户端机密 AKV URL。	字符串
byoaSecretName	在 AKV 中自带应用客户端机密名称。	字符串

GlobalParameterDefinitionSpecification

名字	描述	价值

GlobalParameterSpecification

名字	描述	价值
类型	全局参数类型。	“Array” “Bool” “Float” “Int” “Object” “String”（必需）
价值	参数的值。	任何（必需）

Microsoft.DataFactory/factories

名字	描述	价值
apiVersion	API 版本	'2018-06-01'
身份	工厂的托管服务标识。	FactoryIdentity
位置	资源位置。	字符串
名字	资源名称	字符串约束：最小长度 = 3 最大长度 = 3 模式 = `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$` （必需）
性能	工厂的属性。	FactoryProperties
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
类型	资源类型	“Microsoft.DataFactory/factories”

PurviewConfiguration

名字	描述	价值
purviewResourceId	Purview 资源 ID。	字符串

ResourceTags

名字	描述	价值

UserAssignedIdentitiesDefinitionSpecification

名字	描述	价值

快速入门模板

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

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

Terraform （AzAPI 提供程序）资源定义

工厂资源类型可以使用目标操作进行部署：

资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataFactory/factories@2018-06-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = ?
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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 对象

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

对于 FactoryGitHubConfiguration，请使用：

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

对于 FactoryVSTSConfiguration，请使用：

{
  projectName = "string"
  tenantId = "string"
  type = "FactoryVSTSConfiguration"
}

属性值

CMKIdentityDefinition

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

EncryptionConfiguration

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

FactoryGitHubConfiguration

名字	描述	价值
clientId	GitHub 自带应用客户端 ID。	字符串
clientSecret	GitHub 自带应用客户端机密信息。	GitHubClientSecret
hostName	GitHub Enterprise 主机名。例如：`https://github.mydomain.com`	字符串
类型	存储库配置的类型。	“FactoryGitHubConfiguration”（必需）

FactoryIdentity

名字	描述	价值
类型	标识类型。	“SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”（必需）
userAssignedIdentities	工厂的用户分配标识列表。	UserAssignedIdentitiesDefinitionSpecification

FactoryProperties

名字	描述	价值
加密	为工厂启用客户管理的密钥的属性。	EncryptionConfiguration
globalParameters	工厂的参数列表。	GlobalParameterDefinitionSpecification
publicNetworkAccess	是否允许对数据工厂进行公用网络访问。	“Disabled” “Enabled”
purviewConfiguration	工厂的 Purview 信息。	PurviewConfiguration
repoConfiguration	工厂的 Git 存储库信息。	FactoryRepoConfiguration

FactoryRepoConfiguration

名字	描述	价值
accountName	帐户名称。	string （必需）
collaborationBranch	协作分支。	string （必需）
disablePublish	在 ADF Studio 中禁用手动发布操作，以支持自动发布。	bool
lastCommitId	上次提交 ID。	字符串
repositoryName	存储库名称。	string （必需）
rootFolder	根文件夹。	string （必需）
类型	对于 FactoryGitHubConfiguration类型，设置为“FactoryGitHubConfiguration”。对于 factoryVstsConfiguration类型，设置为“FactoryVSTSConfiguration”。	“FactoryGitHubConfiguration” “FactoryVSTSConfiguration”（必需）

FactoryVstsConfiguration

名字	描述	价值
projectName	VSTS 项目名称。	string （必需）
tenantId	VSTS 租户 ID。	字符串
类型	存储库配置的类型。	“FactoryVSTSConfiguration”（必需）

GitHubClientSecret

名字	描述	价值
byoaSecretAkvUrl	自带应用客户端机密 AKV URL。	字符串
byoaSecretName	在 AKV 中自带应用客户端机密名称。	字符串

GlobalParameterDefinitionSpecification

名字	描述	价值

GlobalParameterSpecification

名字	描述	价值
类型	全局参数类型。	“Array” “Bool” “Float” “Int” “Object” “String”（必需）
价值	参数的值。	任何（必需）

Microsoft.DataFactory/factories

名字	描述	价值
身份	工厂的托管服务标识。	FactoryIdentity
位置	资源位置。	字符串
名字	资源名称	字符串约束：最小长度 = 3 最大长度 = 3 模式 = `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$` （必需）
性能	工厂的属性。	FactoryProperties
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.DataFactory/factories@2018-06-01”

PurviewConfiguration

名字	描述	价值
purviewResourceId	Purview 资源 ID。	字符串

ResourceTags

名字	描述	价值

UserAssignedIdentitiesDefinitionSpecification

名字	描述	价值

通过

Microsoft.DataFactory 工厂

Bicep 资源定义

资源格式

FactoryRepoConfiguration 对象

属性值

CMKIdentityDefinition

EncryptionConfiguration

FactoryGitHubConfiguration

FactoryIdentity

FactoryProperties

FactoryRepoConfiguration

FactoryVstsConfiguration

GitHubClientSecret

GlobalParameterDefinitionSpecification

GlobalParameterSpecification

Microsoft.DataFactory/factories

PurviewConfiguration

ResourceTags

UserAssignedIdentitiesDefinitionSpecification

快速入门示例

ARM 模板资源定义

资源格式

FactoryRepoConfiguration 对象

属性值

CMKIdentityDefinition

EncryptionConfiguration

FactoryGitHubConfiguration

FactoryIdentity

FactoryProperties

FactoryRepoConfiguration

FactoryVstsConfiguration

GitHubClientSecret

GlobalParameterDefinitionSpecification

GlobalParameterSpecification

Microsoft.DataFactory/factories

PurviewConfiguration

ResourceTags

UserAssignedIdentitiesDefinitionSpecification

快速入门模板

Terraform （AzAPI 提供程序）资源定义

资源格式

FactoryRepoConfiguration 对象

属性值

CMKIdentityDefinition

EncryptionConfiguration

FactoryGitHubConfiguration

FactoryIdentity

FactoryProperties

FactoryRepoConfiguration

FactoryVstsConfiguration

GitHubClientSecret

GlobalParameterDefinitionSpecification

GlobalParameterSpecification

Microsoft.DataFactory/factories

PurviewConfiguration

ResourceTags

UserAssignedIdentitiesDefinitionSpecification

反馈

其他资源