使用 Azure 数据工厂将数据从 Azure Blob 复制到 Azure SQL 数据库

项目
08/13/2024

适用于：Azure 数据工厂 Azure Synapse Analytics

本教程介绍如何创建一个将数据从 Azure Blob 存储复制到 Azure SQL 数据库的数据工厂管道。本教程中的配置模式适用于从基于文件的数据存储复制到关系数据存储。如需支持作为源和接收器的数据存储的列表，请参阅支持的数据存储和格式。

在本教程中，你将执行以下步骤：

创建数据工厂。
创建 Azure 存储和 Azure SQL 数据库链接服务。
创建 Azure BLob 和 Azure SQL 数据库数据集。
创建包含复制活动的管道。
启动管道运行。
监视管道和活动运行。

本教程使用 .NET SDK。可以使用其他机制与 Azure 数据工厂交互；请参阅“快速入门”下的示例。

如果没有 Azure 订阅，请在开始前创建一个试用 Azure 帐户。

先决条件

Azure 存储帐户。可将 Blob 存储用作源数据存储。如果没有 Azure 存储帐户，请参阅创建常规用途的存储帐户。
Azure SQL 数据库。将数据库用作接收器数据存储。如果没有 Azure SQL 数据库中的数据库，请参阅创建 Azure SQL 数据库中的数据库。
Visual Studio。本文中的演练使用 Visual Studio 2019。
Azure SDK for .NET 。
Microsoft Entra 应用程序。如果没有 Microsoft Entra 应用程序，请参阅如何：使用门户创建 Microsoft Entra 应用程序的创建 Microsoft Entra 应用程序部分。复制可以在后续步骤中使用的以下值：应用程序(客户端) ID、身份验证密钥和目录(租户) ID。按照同一文章中的以下说明将应用程序分配到“参与者”角色。

创建 blob 和 SQL 表

现在，请创建源 Blob 和接收器 SQL 表，以便准备本教程所需的 Azure Blob 和 Azure SQL 数据库。

创建源 blob

首先创建源 blob，方法是：创建一个容器并将输入文本文件上传到其中：

打开记事本。复制以下文本，并通过本地方式将其保存到名为 inputEmp.txt 的文件。
```
John|Doe
Jane|Doe
```
使用 Azure 存储资源管理器之类的工具创建 adfv2tutorial 容器，并将 inputEmp.txt 文件上传到该容器。

创建接收器 SQL 表

接下来，创建接收器 SQL 表：

使用以下 SQL 脚本在 Azure SQL 数据库中创建 dbo.emp 表。

CREATE TABLE dbo.emp
(
    ID int IDENTITY(1,1) NOT NULL,
    FirstName varchar(50),
    LastName varchar(50)
)
GO

CREATE CLUSTERED INDEX IX_emp_ID ON dbo.emp (ID);

允许 Azure 服务访问 SQL 数据库。确保允许访问服务器中的 Azure 服务，以便数据工厂服务可以将数据写入 SQL 数据库。若要验证并启用此设置，请执行以下步骤：
1. 转到 Azure 门户以管理 SQL Server。搜索并选择“SQL Server”。
2. 选择服务器。
3. 在 SQL Server 菜单的“安全性”标题下，选择“防火墙和虚拟网络”。
4. 在“防火墙和虚拟网络”页的“允许 Azure 服务和资源访问此服务器”下，选择“启用”。

创建 Visual Studio 项目

使用 Visual Studio 创建 C# .NET 控制台应用程序。

打开 Visual Studio。
在“开始”窗口中，选择“创建新项目” 。
在“创建新项目”窗口的项目类型列表中，选择 C# 版“控制台应用(.NET Framework)”。然后，选择“下一步”。
在“配置新项目”窗口中，输入 ADFv2Tutorial 作为项目名称。对于“位置”，请浏览到要在其中保存项目的目录，或者创建该目录。然后选择“创建”。新项目会显示在 Visual Studio IDE 中。

安装 NuGet 包

接下来，使用 NuGet 包管理器安装所需的库包。

在菜单栏中，选择 “工具”>“NuGet 包管理器”>“包管理器控制台” 。

在“包管理器控制台”窗格中，运行以下命令来安装包。有关 Azure 数据工厂 NuGet 包的信息，请参阅 Microsoft.Azure.Management.DataFactory。

Install-Package Microsoft.Azure.Management.DataFactory
Install-Package Microsoft.Azure.Management.ResourceManager -PreRelease
Install-Package Microsoft.IdentityModel.Clients.ActiveDirectory

创建数据工厂客户端

按这些步骤创建数据工厂客户端。

打开 Program.cs，然后使用以下代码覆盖现有的 using 语句，以便添加对命名空间的引用。

using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Rest;
using Microsoft.Rest.Serialization;
using Microsoft.Azure.Management.ResourceManager;
using Microsoft.Azure.Management.DataFactory;
using Microsoft.Azure.Management.DataFactory.Models;
using Microsoft.IdentityModel.Clients.ActiveDirectory;

将以下代码添加到 Main 方法以设置变量。将 14 个占位符替换为你自己的值。

若要查看当前可以使用数据工厂的 Azure 区域的列表，请参阅可用产品（按区域）。在“产品”下拉列表下，选择“浏览”>“分析”>“数据工厂”。然后，在“区域”下拉列表中选择感兴趣的区域。此时会出现一个网格，其中包含所选区域的数据工厂产品的可用性状态。

注意

数据工厂使用的数据存储（例如 Azure 存储和 Azure SQL 数据库）和计算资源（例如 HDInsight）可以位于其他区域（不同于你为数据工厂选择的区域）。

// Set variables
string tenantID = "<your tenant ID>";
string applicationId = "<your application ID>";
string authenticationKey = "<your authentication key for the application>";
string subscriptionId = "<your subscription ID to create the factory>";
string resourceGroup = "<your resource group to create the factory>";

string region = "<location to create the data factory in, such as China East 2>";
string dataFactoryName = "<name of data factory to create (must be globally unique)>";

// Specify the source Azure Blob information
string storageAccount = "<your storage account name to copy data>";
string storageKey = "<your storage account key>";
string inputBlobPath = "adfv2tutorial/";
string inputBlobName = "inputEmp.txt";

// Specify the sink Azure SQL Database information
string azureSqlConnString =
    "Server=tcp:<your server name>.database.chinacloudapi.cn,1433;" +
    "Database=<your database name>;" +
    "User ID=<your username>@<your server name>;" +
    "Password=<your password>;" +
    "Trusted_Connection=False;Encrypt=True;Connection Timeout=30";
string azureSqlTableName = "dbo.emp";

string storageLinkedServiceName = "AzureStorageLinkedService";
string sqlDbLinkedServiceName = "AzureSqlDbLinkedService";
string blobDatasetName = "BlobDataset";
string sqlDatasetName = "SqlDataset";
string pipelineName = "Adfv2TutorialBlobToSqlCopy";

向 Main 方法中添加用于创建 DataFactoryManagementClient 类的实例的以下代码。将使用此对象来创建数据工厂、链接服务、数据集和管道。还将使用此对象来监视管道运行详细信息。

// Authenticate and create a data factory management client
var context = new AuthenticationContext("https://login.chinacloudapi.cn/" + tenantID);
ClientCredential cc = new ClientCredential(applicationId, authenticationKey);
AuthenticationResult result = context.AcquireTokenAsync(
    "https://management.chinacloudapi.cn/", cc
).Result;
ServiceClientCredentials cred = new TokenCredentials(result.AccessToken);
var client = new DataFactoryManagementClient(cred) { SubscriptionId = subscriptionId , BaseUri = new Uri("https://management.chinacloudapi.cn/")};

创建数据工厂

向 Main 方法中添加用于创建数据工厂的以下代码。

// Create a data factory
Console.WriteLine("Creating a data factory " + dataFactoryName + "...");
Factory dataFactory = new Factory
{
    Location = region,
    Identity = new FactoryIdentity()
};

client.Factories.CreateOrUpdate(resourceGroup, dataFactoryName, dataFactory);
Console.WriteLine(
    SafeJsonConvert.SerializeObject(dataFactory, client.SerializationSettings)
);

while (
    client.Factories.Get(
        resourceGroup, dataFactoryName
    ).ProvisioningState == "PendingCreation"
)
{
    System.Threading.Thread.Sleep(1000);
}

创建链接服务

在本教程中，我们将创建两个链接服务，分别用于源和接收器。

创建 Azure 存储链接服务

在 Main 方法中添加用于创建 Azure 存储链接服务的以下代码。有关支持的属性和信息，请参阅 Azure Blob 链接服务属性。

// Create an Azure Storage linked service
Console.WriteLine("Creating linked service " + storageLinkedServiceName + "...");

LinkedServiceResource storageLinkedService = new LinkedServiceResource(
    new AzureStorageLinkedService
    {
        ConnectionString = new SecureString(
            "DefaultEndpointsProtocol=https;AccountName=" + storageAccount +
            ";AccountKey=" + storageKey +
	    ";EndpointSuffix=core.chinacloudapi.cn"
        )
    }
);

client.LinkedServices.CreateOrUpdate(
    resourceGroup, dataFactoryName, storageLinkedServiceName, storageLinkedService
);
Console.WriteLine(
    SafeJsonConvert.SerializeObject(storageLinkedService, client.SerializationSettings)
);

创建 Azure SQL 数据库链接服务

向 Main 方法中添加用于创建 Azure SQL 数据库链接服务的以下代码。有关支持的属性和信息，请参阅 Azure SQL 数据库链接服务属性。

// Create an Azure SQL Database linked service
Console.WriteLine("Creating linked service " + sqlDbLinkedServiceName + "...");

LinkedServiceResource sqlDbLinkedService = new LinkedServiceResource(
    new AzureSqlDatabaseLinkedService
    {
        ConnectionString = new SecureString(azureSqlConnString)
    }
);

client.LinkedServices.CreateOrUpdate(
    resourceGroup, dataFactoryName, sqlDbLinkedServiceName, sqlDbLinkedService
);
Console.WriteLine(
    SafeJsonConvert.SerializeObject(sqlDbLinkedService, client.SerializationSettings)
);

创建数据集

在本部分中创建两个数据集：一个用于源，另一个用于接收器。

为源 Azure Blob 创建数据集

向 Main 方法中添加用于创建 Azure blob 数据集的以下代码。有关支持的属性和信息，请参阅 Azure Blob 数据集属性。

在 Azure Blob 中定义表示源数据的数据集。此 Blob 数据集引用在上一步中创建的 Azure 存储链接服务，并说明以下信息：

要从其中复制数据的 Blob 的位置：FolderPath 和 FileName
指示分析内容方式的 blob 格式：TextFormat 及其设置（例如列分隔符）
数据结构，包括列名称和数据类型（在本示例中映射到接收器 SQL 表）

// Create an Azure Blob dataset
Console.WriteLine("Creating dataset " + blobDatasetName + "...");
DatasetResource blobDataset = new DatasetResource(
    new AzureBlobDataset
    {
        LinkedServiceName = new LinkedServiceReference {
            ReferenceName = storageLinkedServiceName
        },
        FolderPath = inputBlobPath,
        FileName = inputBlobName,
        Format = new TextFormat { ColumnDelimiter = "|" },
        Structure = new List<DatasetDataElement>
        {
            new DatasetDataElement { Name = "FirstName", Type = "String" },
            new DatasetDataElement { Name = "LastName", Type = "String" }
        }
    }
);

client.Datasets.CreateOrUpdate(
    resourceGroup, dataFactoryName, blobDatasetName, blobDataset
);
Console.WriteLine(
    SafeJsonConvert.SerializeObject(blobDataset, client.SerializationSettings)
);

为接收器 Azure SQL 数据库创建数据集

向 Main 方法中添加用于创建 Azure SQL 数据库数据集的以下代码。有关支持的属性和信息，请参阅 Azure SQL 数据库数据集属性。

在 Azure SQL 数据库中定义表示接收器数据的数据集。此数据集引用在上一步创建的 Azure SQL 数据库链接服务。它还指定用于保存所复制数据的 SQL 表。

// Create an Azure SQL Database dataset
Console.WriteLine("Creating dataset " + sqlDatasetName + "...");
DatasetResource sqlDataset = new DatasetResource(
    new AzureSqlTableDataset
    {
        LinkedServiceName = new LinkedServiceReference
        {
            ReferenceName = sqlDbLinkedServiceName
        },
        TableName = azureSqlTableName
    }
);

client.Datasets.CreateOrUpdate(
    resourceGroup, dataFactoryName, sqlDatasetName, sqlDataset
);
Console.WriteLine(
    SafeJsonConvert.SerializeObject(sqlDataset, client.SerializationSettings)
);

创建管道

向 Main 方法中添加用于创建包含复制活动的管道的以下代码。在本教程中，此管道包含一个活动：CopyActivity，它接受 Blob 数据集作为源，接受 SQL 数据集作为接收器。若要了解复制活动详情，请参阅 Azure 数据工厂中的复制活动。

// Create a pipeline with copy activity
Console.WriteLine("Creating pipeline " + pipelineName + "...");
PipelineResource pipeline = new PipelineResource
{
    Activities = new List<Activity>
    {
        new CopyActivity
        {
            Name = "CopyFromBlobToSQL",
            Inputs = new List<DatasetReference>
            {
                new DatasetReference() { ReferenceName = blobDatasetName }
            },
            Outputs = new List<DatasetReference>
            {
                new DatasetReference { ReferenceName = sqlDatasetName }
            },
            Source = new BlobSource { },
            Sink = new SqlSink { }
        }
    }
};

client.Pipelines.CreateOrUpdate(resourceGroup, dataFactoryName, pipelineName, pipeline);
Console.WriteLine(
    SafeJsonConvert.SerializeObject(pipeline, client.SerializationSettings)
);

创建管道运行

在 Main 方法中添加用于触发管道运行的以下代码。

// Create a pipeline run
Console.WriteLine("Creating pipeline run...");
CreateRunResponse runResponse = client.Pipelines.CreateRunWithHttpMessagesAsync(
    resourceGroup, dataFactoryName, pipelineName
).Result.Body;
Console.WriteLine("Pipeline run ID: " + runResponse.RunId);

监视管道运行

现在请插入代码，以便检查管道运行状态并获取有关复制活动运行的详细信息。

在 Main 方法中添加以下代码用于持续检查管道运行状态，直到它完成数据复制为止。

// Monitor the pipeline run
Console.WriteLine("Checking pipeline run status...");
PipelineRun pipelineRun;
while (true)
{
    pipelineRun = client.PipelineRuns.Get(
        resourceGroup, dataFactoryName, runResponse.RunId
    );
    Console.WriteLine("Status: " + pipelineRun.Status);
    if (pipelineRun.Status == "InProgress")
        System.Threading.Thread.Sleep(15000);
    else
        break;
}

在 Main 方法中添加以下代码用于检索复制活动运行详细信息，例如，读取或写入的数据的大小。

// Check the copy activity run details
Console.WriteLine("Checking copy activity run details...");

RunFilterParameters filterParams = new RunFilterParameters(
    DateTime.UtcNow.AddMinutes(-10), DateTime.UtcNow.AddMinutes(10)
);

ActivityRunsQueryResponse queryResponse = client.ActivityRuns.QueryByPipelineRun(
    resourceGroup, dataFactoryName, runResponse.RunId, filterParams
);

if (pipelineRun.Status == "Succeeded")
{
    Console.WriteLine(queryResponse.Value.First().Output);
}
else
    Console.WriteLine(queryResponse.Value.First().Error);

Console.WriteLine("\nPress any key to exit...");
Console.ReadKey();

运行代码

通过选择“生成”>“生成解决方案”来生成应用程序。然后通过选择“调试”>“开始调试”来启动应用程序，并验证管道执行情况。

控制台会输出数据工厂、链接服务、数据集、管道和管道运行的创建进度。然后，检查管道运行状态。请等到出现包含数据读取/写入大小的复制活动运行详细信息。然后，可以使用 SQL Server Management Studio (SSMS) 或 Visual Studio 之类的工具连接到目标 Azure SQL 数据库，并检查指定的目标表是否包含复制的数据。

示例输出

Creating a data factory AdfV2Tutorial...
{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "China East 2"
}
Creating linked service AzureStorageLinkedService...
{
  "properties": {
    "type": "AzureStorage",
    "typeProperties": {
      "connectionString": {
        "type": "SecureString",
        "value": "DefaultEndpointsProtocol=https;AccountName=<accountName>;AccountKey=<accountKey>;EndpointSuffix=core.chinacloudapi.cn"
      }
    }
  }
}
Creating linked service AzureSqlDbLinkedService...
{
  "properties": {
    "type": "AzureSqlDatabase",
    "typeProperties": {
      "connectionString": {
        "type": "SecureString",
        "value": "Server=tcp:<servername>.database.chinacloudapi.cn,1433;Database=<databasename>;User ID=<username>@<servername>;Password=<password>;Trusted_Connection=False;Encrypt=True;Connection Timeout=30"
      }
    }
  }
}
Creating dataset BlobDataset...
{
  "properties": {
    "type": "AzureBlob",
    "typeProperties": {
      "folderPath": "adfv2tutorial/",
      "fileName": "inputEmp.txt",
      "format": {
        "type": "TextFormat",
        "columnDelimiter": "|"
      }
    },
    "structure": [
      {
        "name": "FirstName",
        "type": "String"
      },
      {
        "name": "LastName",
        "type": "String"
      }
    ],
    "linkedServiceName": {
      "type": "LinkedServiceReference",
      "referenceName": "AzureStorageLinkedService"
    }
  }
}
Creating dataset SqlDataset...
{
  "properties": {
    "type": "AzureSqlTable",
    "typeProperties": {
      "tableName": "dbo.emp"
    },
    "linkedServiceName": {
      "type": "LinkedServiceReference",
      "referenceName": "AzureSqlDbLinkedService"
    }
  }
}
Creating pipeline Adfv2TutorialBlobToSqlCopy...
{
  "properties": {
    "activities": [
      {
        "type": "Copy",
        "typeProperties": {
          "source": {
            "type": "BlobSource"
          },
          "sink": {
            "type": "SqlSink"
          }
        },
        "inputs": [
          {
            "type": "DatasetReference",
            "referenceName": "BlobDataset"
          }
        ],
        "outputs": [
          {
            "type": "DatasetReference",
            "referenceName": "SqlDataset"
          }
        ],
        "name": "CopyFromBlobToSQL"
      }
    ]
  }
}
Creating pipeline run...
Pipeline run ID: 1cd03653-88a0-4c90-aabc-ae12d843e252
Checking pipeline run status...
Status: InProgress
Status: InProgress
Status: Succeeded
Checking copy activity run details...
{
  "dataRead": 18,
  "dataWritten": 28,
  "rowsCopied": 2,
  "copyDuration": 2,
  "throughput": 0.01,
  "errors": [],
  "effectiveIntegrationRuntime": "DefaultIntegrationRuntime (China East 2)",
  "usedDataIntegrationUnits": 2,
  "billedDuration": 2
}

Press any key to exit...

此示例中的管道将数据从 Azure Blob 存储中的一个位置复制到另一个位置。你已了解如何执行以下操作：

创建数据工厂。
创建 Azure 存储和 Azure SQL 数据库链接服务。
创建 Azure BLob 和 Azure SQL 数据库数据集。
创建包含复制活动的管道。
启动管道运行。
监视管道和活动运行。

若要了解如何将数据从本地复制到云，请转到以下教程：

将数据从本地复制到云

通过