Microsoft.DataFactory Factory

• 最新
• 2018-06-01
• 2017-09-01-preview

Bicep 資源定義

工廠資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DataFactory/factoryies 資源，請將下列 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	使用者指派身分識別的資源識別碼，以向客戶的密鑰保存庫進行驗證。	字串

EncryptionConfiguration

名字	描述	價值
身份	使用者指派的身分識別可用來向客戶的密鑰保存庫進行驗證。 如果未提供受控服務識別，則會使用 。	CMKIdentityDefinition
keyName	要作為客戶管理金鑰的 Azure Key Vault 中的密鑰名稱。	字串 （必要）
keyVersion	CMK 所使用的金鑰版本。 如果未提供，則會使用最新版本。	字串
vaultBaseUrl	用於 CMK 的 Azure Key Vault URL。	字串 （必要）

FactoryGitHubConfiguration

名字	描述	價值
clientId	GitHub 自備應用程式用戶端標識碼。	字串
clientSecret	GitHub 自備應用程式用戶端秘密資訊。	GitHubClientSecret
hostName	GitHub Enterprise 主機名。 例如：https://github.mydomain.com	字串
類型	存放庫組態的類型。	'FactoryGitHubConfiguration' （必要）

FactoryIdentity

名字	描述	價值
類型	識別類型。	'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned' （必要）
userAssignedIdentities	處理站的使用者指派身分識別清單。	UserAssignedIdentitiesDefinitionSpecification

FactoryProperties

名字	描述	價值
加密	啟用處理站客戶管理金鑰的屬性。	EncryptionConfiguration
globalParameters	Factory 的參數清單。	GlobalParameterDefinitionSpecification
publicNetworkAccess	是否允許數據處理站存取公用網路。	'Disabled' 'Enabled'
purviewConfiguration	處理站的 Purview 資訊。	PurviewConfiguration
repoConfiguration	處理站的 Git 存放庫資訊。	FactoryRepoConfiguration

FactoryRepoConfiguration

名字	描述	價值
accountName	帳戶名稱。	字串 （必要）
collaborationBranch	共同作業分支。	字串 （必要）
disablePublish	停用 ADF Studio 中的手動發佈作業，以偏好自動發佈。	bool
lastCommitId	上次認可標識碼。	字串
repositoryName	存放庫名稱。	字串 （必要）
rootFolder	根資料夾。	字串 （必要）
類型	針對 factoryGitHubConfiguration 類型設定為 'FactoryGitHubConfiguration'，。 針對 factoryVstsConfiguration 類型設定為 'FactoryVSTSConfiguration'，。	'FactoryGitHubConfiguration' 'FactoryVSTSConfiguration' （必要）

FactoryVstsConfiguration

名字	描述	價值
projectName	VSTS 項目名稱。	字串 （必要）
tenantId	VSTS 租使用者標識碼。	字串
類型	存放庫組態的類型。	'FactoryVSTSConfiguration' （必要）

GitHubClientSecret

名字	描述	價值
byoaSecretAkvUrl	自備應用程式用戶端密碼 AKV URL。	字串
byoaSecretName	在 AKV 中攜帶您自己的應用程式用戶端密碼名稱。	字串

GlobalParameterDefinitionSpecification

名字	描述	價值

GlobalParameterSpecification

名字	描述	價值
類型	全域參數類型。	'Array' 'Bool' 'Float' 'Int' 'Object' 'String' （必要）
價值	參數的值。	任何 （必要）

Microsoft.DataFactory/factoryies

名字	描述	價值
身份	處理站的受控服務識別。	FactoryIdentity
位置	資源位置。	字串
名字	資源名稱	字串 約束： 最小長度 = 3 最大長度 = 3 模式 = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ （必要）
性能	Factory 的屬性。	FactoryProperties
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤

PurviewConfiguration

名字	描述	價值
purviewResourceId	Purview 資源標識碼。	字串

ResourceTags

名字	描述	價值

UserAssignedIdentitiesDefinitionSpecification

名字	描述	價值

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案	描述
使用 Git 和受控 vnet 組態 Azure Data Factory	此範本會使用 Git 設定和受控虛擬網路來建立 Azure Data Factory。
建立 V2 Data Factory	此範本會建立 V2 資料處理站，將資料從 Azure Blob 記憶體中的資料夾複製到記憶體中的另一個資料夾。
建立空白數據處理站	此範本會建立空的數據處理站
在 Azure 架構上部署體育分析	建立已啟用 ADLS Gen 2 的 Azure 記憶體帳戶、具有記憶體帳戶連結服務的 Azure Data Factory 實例（如果已部署的 Azure SQL Database），以及 Azure Databricks 實例。 部署範本和 ADF 實例受控識別的使用者 AAD 身分識別，將會在記憶體帳戶上授與記憶體 Blob 數據參與者角色。 還有一個選項可用來部署 Azure Key Vault 實例、Azure SQL Database 和 Azure 事件中樞（適用於串流使用案例）。 部署 Azure Key Vault 時，部署範本之使用者的 Data Factory 受控識別和 AAD 身分識別將會獲得 Key Vault 秘密使用者角色。
FinOps 中樞	此範本會建立新的 FinOps 中樞實例，包括 Data Lake 記憶體和 Data Factory。
Azure Data Factory 可以 更多 - 按兩下即可嘗試 Azure Data Factory	此範本會建立數據處理站管線，以將複製活動從 Azure Blob 複製到另一個 Azure Blob

ARM 樣本資源定義

工廠資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DataFactory/factoryies 資源，請將下列 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	使用者指派身分識別的資源識別碼，以向客戶的密鑰保存庫進行驗證。	字串

EncryptionConfiguration

名字	描述	價值
身份	使用者指派的身分識別可用來向客戶的密鑰保存庫進行驗證。 如果未提供受控服務識別，則會使用 。	CMKIdentityDefinition
keyName	要作為客戶管理金鑰的 Azure Key Vault 中的密鑰名稱。	字串 （必要）
keyVersion	CMK 所使用的金鑰版本。 如果未提供，則會使用最新版本。	字串
vaultBaseUrl	用於 CMK 的 Azure Key Vault URL。	字串 （必要）

FactoryGitHubConfiguration

名字	描述	價值
clientId	GitHub 自備應用程式用戶端標識碼。	字串
clientSecret	GitHub 自備應用程式用戶端秘密資訊。	GitHubClientSecret
hostName	GitHub Enterprise 主機名。 例如：https://github.mydomain.com	字串
類型	存放庫組態的類型。	'FactoryGitHubConfiguration' （必要）

FactoryIdentity

名字	描述	價值
類型	識別類型。	'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned' （必要）
userAssignedIdentities	處理站的使用者指派身分識別清單。	UserAssignedIdentitiesDefinitionSpecification

FactoryProperties

名字	描述	價值
加密	啟用處理站客戶管理金鑰的屬性。	EncryptionConfiguration
globalParameters	Factory 的參數清單。	GlobalParameterDefinitionSpecification
publicNetworkAccess	是否允許數據處理站存取公用網路。	'Disabled' 'Enabled'
purviewConfiguration	處理站的 Purview 資訊。	PurviewConfiguration
repoConfiguration	處理站的 Git 存放庫資訊。	FactoryRepoConfiguration

FactoryRepoConfiguration

名字	描述	價值
accountName	帳戶名稱。	字串 （必要）
collaborationBranch	共同作業分支。	字串 （必要）
disablePublish	停用 ADF Studio 中的手動發佈作業，以偏好自動發佈。	bool
lastCommitId	上次認可標識碼。	字串
repositoryName	存放庫名稱。	字串 （必要）
rootFolder	根資料夾。	字串 （必要）
類型	針對 factoryGitHubConfiguration 類型設定為 'FactoryGitHubConfiguration'，。 針對 factoryVstsConfiguration 類型設定為 'FactoryVSTSConfiguration'，。	'FactoryGitHubConfiguration' 'FactoryVSTSConfiguration' （必要）

FactoryVstsConfiguration

名字	描述	價值
projectName	VSTS 項目名稱。	字串 （必要）
tenantId	VSTS 租使用者標識碼。	字串
類型	存放庫組態的類型。	'FactoryVSTSConfiguration' （必要）

GitHubClientSecret

名字	描述	價值
byoaSecretAkvUrl	自備應用程式用戶端密碼 AKV URL。	字串
byoaSecretName	在 AKV 中攜帶您自己的應用程式用戶端密碼名稱。	字串

GlobalParameterDefinitionSpecification

名字	描述	價值

GlobalParameterSpecification

名字	描述	價值
類型	全域參數類型。	'Array' 'Bool' 'Float' 'Int' 'Object' 'String' （必要）
價值	參數的值。	任何 （必要）

Microsoft.DataFactory/factoryies

名字	描述	價值
apiVersion	API 版本	'2018-06-01'
身份	處理站的受控服務識別。	FactoryIdentity
位置	資源位置。	字串
名字	資源名稱	字串 約束： 最小長度 = 3 最大長度 = 3 模式 = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ （必要）
性能	Factory 的屬性。	FactoryProperties
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤
類型	資源類型	'Microsoft.DataFactory/factories'

PurviewConfiguration

名字	描述	價值
purviewResourceId	Purview 資源標識碼。	字串

ResourceTags

名字	描述	價值

UserAssignedIdentitiesDefinitionSpecification

名字	描述	價值

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
使用 Git 和受控 vnet 組態 Azure Data Factory	此範本會使用 Git 設定和受控虛擬網路來建立 Azure Data Factory。
使用 Azure Data Factory 大量複製	此範本會建立 V2 數據處理站，以將大量 Azure SQL 資料庫的數據複製到 Azure SQL 數據倉儲。
建立 Data Factory，從 Salesforce 複製到 Blob	此範本會使用 Azure Data Factory 來執行從 Salesforce 到 Azure Blob 的數據移動
建立 V2 Data Factory	此範本會建立 V2 資料處理站，將資料從 Azure Blob 記憶體中的資料夾複製到記憶體中的另一個資料夾。
建立 V2 資料處理站 （MySQL）	此範本會建立 V2 資料處理站，將數據從 Azure Blob 記憶體中的資料夾複製到適用於 MySQL 的 Azure 資料庫中的數據表。
建立 V2 資料處理站 （PostGre）	此範本會建立 V2 數據處理站，將數據從 Azure Blob 記憶體中的資料夾複製到適用於 PostgreSQL 的 Azure 資料庫中的數據表。
建立 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 Data Factory 實例（如果已部署的 Azure SQL Database），以及 Azure Databricks 實例。 部署範本和 ADF 實例受控識別的使用者 AAD 身分識別，將會在記憶體帳戶上授與記憶體 Blob 數據參與者角色。 還有一個選項可用來部署 Azure Key Vault 實例、Azure SQL Database 和 Azure 事件中樞（適用於串流使用案例）。 部署 Azure Key Vault 時，部署範本之使用者的 Data Factory 受控識別和 AAD 身分識別將會獲得 Key Vault 秘密使用者角色。
FinOps 中樞	此範本會建立新的 FinOps 中樞實例，包括 Data Lake 記憶體和 Data Factory。
Azure Data Factory 可以 更多 - 按兩下即可嘗試 Azure Data Factory	此範本會建立數據處理站管線，以將複製活動從 Azure Blob 複製到另一個 Azure Blob
在 Azure 中布建 SSIS 運行時間	此範本會建立 V2 Data Factory，然後布建 Azure SSIS 整合運行時間

Terraform （AzAPI 提供者） 資源定義

工廠資源類型可以使用目標作業來部署：

• 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DataFactory/factoryies 資源，請將下列 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	使用者指派身分識別的資源識別碼，以向客戶的密鑰保存庫進行驗證。	字串

EncryptionConfiguration

名字	描述	價值
身份	使用者指派的身分識別可用來向客戶的密鑰保存庫進行驗證。 如果未提供受控服務識別，則會使用 。	CMKIdentityDefinition
keyName	要作為客戶管理金鑰的 Azure Key Vault 中的密鑰名稱。	字串 （必要）
keyVersion	CMK 所使用的金鑰版本。 如果未提供，則會使用最新版本。	字串
vaultBaseUrl	用於 CMK 的 Azure Key Vault URL。	字串 （必要）

FactoryGitHubConfiguration

名字	描述	價值
clientId	GitHub 自備應用程式用戶端標識碼。	字串
clientSecret	GitHub 自備應用程式用戶端秘密資訊。	GitHubClientSecret
hostName	GitHub Enterprise 主機名。 例如：https://github.mydomain.com	字串
類型	存放庫組態的類型。	'FactoryGitHubConfiguration' （必要）

FactoryIdentity

名字	描述	價值
類型	識別類型。	'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned' （必要）
userAssignedIdentities	處理站的使用者指派身分識別清單。	UserAssignedIdentitiesDefinitionSpecification

FactoryProperties

名字	描述	價值
加密	啟用處理站客戶管理金鑰的屬性。	EncryptionConfiguration
globalParameters	Factory 的參數清單。	GlobalParameterDefinitionSpecification
publicNetworkAccess	是否允許數據處理站存取公用網路。	'Disabled' 'Enabled'
purviewConfiguration	處理站的 Purview 資訊。	PurviewConfiguration
repoConfiguration	處理站的 Git 存放庫資訊。	FactoryRepoConfiguration

FactoryRepoConfiguration

名字	描述	價值
accountName	帳戶名稱。	字串 （必要）
collaborationBranch	共同作業分支。	字串 （必要）
disablePublish	停用 ADF Studio 中的手動發佈作業，以偏好自動發佈。	bool
lastCommitId	上次認可標識碼。	字串
repositoryName	存放庫名稱。	字串 （必要）
rootFolder	根資料夾。	字串 （必要）
類型	針對 factoryGitHubConfiguration 類型設定為 'FactoryGitHubConfiguration'，。 針對 factoryVstsConfiguration 類型設定為 'FactoryVSTSConfiguration'，。	'FactoryGitHubConfiguration' 'FactoryVSTSConfiguration' （必要）

FactoryVstsConfiguration

名字	描述	價值
projectName	VSTS 項目名稱。	字串 （必要）
tenantId	VSTS 租使用者標識碼。	字串
類型	存放庫組態的類型。	'FactoryVSTSConfiguration' （必要）

GitHubClientSecret

名字	描述	價值
byoaSecretAkvUrl	自備應用程式用戶端密碼 AKV URL。	字串
byoaSecretName	在 AKV 中攜帶您自己的應用程式用戶端密碼名稱。	字串

GlobalParameterDefinitionSpecification

名字	描述	價值

GlobalParameterSpecification

名字	描述	價值
類型	全域參數類型。	'Array' 'Bool' 'Float' 'Int' 'Object' 'String' （必要）
價值	參數的值。	任何 （必要）

Microsoft.DataFactory/factoryies

名字	描述	價值
身份	處理站的受控服務識別。	FactoryIdentity
位置	資源位置。	字串
名字	資源名稱	字串 約束： 最小長度 = 3 最大長度 = 3 模式 = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ （必要）
性能	Factory 的屬性。	FactoryProperties
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.DataFactory/factories@2018-06-01”

PurviewConfiguration

名字	描述	價值
purviewResourceId	Purview 資源標識碼。	字串

ResourceTags

名字	描述	價值

UserAssignedIdentitiesDefinitionSpecification

名字	描述	價值