使用支持 Azure 的 dtexec 实用工具运行 SQL Server Integration Services 包

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

本文介绍支持 Azure 的 dtexec (AzureDTExec) 命令提示符实用工具。 此实用工具用于在 Azure 数据工厂中的 Azure-SSIS Integration Runtime (IR) 上运行 SQL Server Integration Services (SSIS) 包。

SQL Server 随附了传统的 dtexec 实用工具。 有关详细信息，请参阅 dtexec 实用工具。 此实用工具通常由 ActiveBatch 和 Control-M 等第三方业务流程协调程序或计划程序调用，以在本地运行 SSIS 包。

SQL Server Management Studio (SSMS) 工具随附了新式 AzureDTExec 实用工具。 它也可以由第三方业务流程协调程序或计划程序调用，以在 Azure 中运行 SSIS 包。 此实用程序有助于将 SSIS 包直接转移或迁移到云中。 迁移后，如果你想要在日常运营中保持使用第三方业务流程协调程序或计划程序，这些程序现在可以调用 AzureDTExec 而不是 dtexec。

AzureDTExec 将包作为数据工厂管道中的“执行 SSIS 包”活动运行。 有关详细信息，请参阅将 SSIS 包作为 Azure 数据工厂活动运行。

可以通过 SSMS 将 AzureDTExec 配置为使用在数据工厂中生成管道的 Microsoft Entra 应用程序。 还可将其配置为访问存储包的文件系统、文件共享或 Azure 文件存储。 根据提供给 AzureDTExec 的调用选项值，AzureDTExec 将生成并运行一个独特的数据工厂管道，其中包含“执行 SSIS 包”活动。 结合提供的相同选项值调用 AzureDTExec 会重新运行现有管道。

先决条件

若要使用 AzureDTExec，请下载并安装最新版本的 SSMS（18.3 或更高版本）。 从此网站下载它。

配置 AzureDTExec 实用工具

在本地计算机上安装 SSMS 会同时安装 AzureDTExec。 若要配置 AzureDTExec 的设置，请使用“以管理员身份运行”选项启动 SSMS。 然后选择“工具”>“迁移到 Azure”>“配置支持 Azure 的 DTExec”。

如果使用管理特权执行此操作，将会打开一个“AzureDTExecConfig”窗口，并将设置写入 AzureDTExec.settings 文件中。 如果不是以管理员身份运行 SSMS，将打开“用户帐户控制(UAC)”窗口。 输入管理员密码以提升特权。

在“AzureDTExecConfig”窗口中，按如下所示输入配置设置：

• ApplicationId：输入使用适当权限创建的 Microsoft Entra 应用的唯一标识符，以在数据工厂中生成管道。 有关详细信息，请参阅通过 Azure 门户创建 Microsoft Entra 应用和服务主体。
• AuthenticationKey：输入 Microsoft Entra 应用的身份验证密钥。
• TenantId：输入在其下创建了 Microsoft Entra 应用的 Microsoft Entra 租户的唯一标识符。
• DataFactory：输入数据工厂的名称，其中包含“执行 SSIS 包”活动的独特管道是基于调用 AzureDTExec 时提供的选项值生成的。
• IRName：输入数据工厂中 Azure-SSIS IR 的名称，调用 AzureDTExec 时，该 IR 上的通用命名约定 (UNC) 路径中指定的包将会运行。
• PipelineNameHashStrLen：输入基于调用 AzureDTExec 时提供的选项值生成的哈希字符串的长度。 这些字符串用于构成在 Azure-SSIS IR 上运行包的数据工厂管道的唯一名称。 32 个字符的长度通常已足够。
• ResourceGroup：输入在其中创建了数据工厂的 Azure 资源组的名称。
• SubscriptionId：输入在其下创建了数据工厂的 Azure 订阅的唯一标识符。
• LogAccessDomain：输入域凭据，以便在写入日志文件时访问 UNC 路径中的日志文件夹；当指定了 LogPath 且 LogLevel 不是 null 时，此字段是必填的。
• LogAccessPassword：输入密码凭据，以便在写入日志文件时访问 UNC 路径中的日志文件夹；当指定了 LogPath 且 LogLevel 不是 null 时，此字段是必填的。
• LogAccessUserName：输入用户名凭据，以便在写入日志文件时访问 UNC 路径中的日志文件夹；当指定了 LogPath 且 LogLevel 不是 null 时，此字段是必填的。
• LogLevel：为 Azure-SSIS IR 上的包执行输入所选的日志记录范围，预定义的选项包括“null”、“Basic”、“Verbose”或“Performance”。
• LogPath：输入日志文件夹的 UNC 路径，在 Azure-SSIS IR 上执行包时生成的日志文件将写入其中。
• PackageAccessDomain：输入域凭据，以访问调用 AzureDTExec 时指定的 UNC 路径中的包。
• PackageAccessPassword：输入密码凭据，以访问调用 AzureDTExec 时指定的 UNC 路径中的包。
• PackageAccessUserName：输入用户名凭据，以访问调用 AzureDTExec 时指定的 UNC 路径中的包。

若要将包和日志文件存储在本地的文件系统或文件共享中，请将 Azure-SSIS IR 加入到与本地网络连接的虚拟网络，使 IR 能够提取包并写入日志文件。 有关详细信息，请参阅将 Azure-SSIS IR 加入虚拟网络。

若要避免以纯文本显示写入 AzureDTExec.settings 的敏感值，请将其编码为 Base64 编码的字符串。 调用 AzureDTExec 时，所有 Base64 编码的字符串将解码回到原始值。 可以通过限制能够访问 AzureDTExec 文件的帐户来进一步保护该文件。

调用 AzureDTExec 实用工具

可以在命令行提示符下调用 AzureDTExec，并为用例方案中的特定选项提供相关值。

该实用工具安装在 {SSMS Folder}\Common7\IDE\CommonExtensions\Microsoft\SSIS\150\Binn 中。 可将其路径添加到“PATH”环境变量，以便能够从任意位置调用它。

> cd "C:\Program Files (x86)\Microsoft SQL Server Management Studio 18\Common7\IDE\CommonExtensions\Microsoft\SSIS\150\Binn"
> AzureDTExec.exe  ^
  /F \\MyStorageAccount.file.core.chinacloudapi.cn\MyFileShare\MyPackage.dtsx  ^
  /Conf \\MyStorageAccount.file.core.chinacloudapi.cn\MyFileShare\MyConfig.dtsConfig  ^
  /Conn "MyConnectionManager;Data Source=MyDatabaseServer.database.chinacloudapi.cn;User ID=MyAdminUsername;Password=MyAdminPassword;Initial Catalog=MyDatabase"  ^
  /Set \package.variables[MyVariable].Value;MyValue  ^
  /De MyEncryptionPassword

调用 AzureDTExec 时可用的选项类似于调用 dtexec 时可用的选项。 有关详细信息，请参阅 dtexec 实用工具。 目前支持以下选项：

• /F[ile] ：加载存储在文件系统、文件共享或 Azure 文件存储中的包。 可以指定包文件在文件系统、文件共享或 Azure 文件存储中的 UNC 路径及其 .dtsx 扩展名，作为此选项的值。 如果指定的 UNC 路径包含空格，请用引号括住整个路径。
• /Conf[igFile] ：指定要从中提取值的配置文件。 使用此选项可为包设置不同的运行时配置（不同于设计时指定的配置）。 可以在 XML 配置文件中存储不同的设置，然后在执行包之前加载这些设置。 有关详细信息，请参阅 SSIS 包配置。 若要指定此选项的值，请使用配置文件在文件系统、文件共享或 Azure 文件存储中的 UNC 路径及其 dtsConfig 扩展名。 如果指定的 UNC 路径包含空格，请用引号括住整个路径。
• /Conn[ection] ：为包中的现有连接管理器指定连接字符串。 使用此选项可为包中的现有连接管理器设置不同的运行时连接字符串（不同于设计时指定的连接字符串）。 按如下所示指定此选项的值：connection_manager_name_or_id;connection_string [[;connection_manager_name_or_id;connection_string]...]。
• /Set：重写包中参数、变量、属性、容器、日志提供程序、Foreach 枚举器或连接的配置。 可以多次指定此选项。 按如下所示指定此选项的值：property_path;value。 例如，\package.variables[counter].Value;1 将 counter 变量的值重写为 1。 可以使用“包配置”向导来查找、复制和粘贴包中要重写其值的项的 property_path 值。 有关详细信息，请参阅包配置向导。
• /De[crypt] ：设置使用 EncryptAllWithPassword/EncryptSensitiveWithPassword 保护级别为包配置的解密密码。

相关内容

在调用 AzureDTExec 时生成并运行包含“执行 SSIS 包”活动的唯一管道后，可以在数据工厂门户中监视这些管道。 如果要使用数据工厂来协调/计划这些管道，还可以向这些管道分配数据工厂触发器。 有关详细信息，请参阅将 SSIS 包作为数据工厂活动运行。