Skip to content

Commit b3c631a

Browse files
committed
edit pass: how-to-invoke-ssis-package-managed-instance-agent
1 parent f62f9ed commit b3c631a

File tree

1 file changed

+70
-54
lines changed

1 file changed

+70
-54
lines changed
Lines changed: 70 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Execute SSIS packages by Azure SQL Managed Instance Agent
3-
description: Learn how to execute SSIS packages by Azure SQL Managed Instance Agent.
2+
title: Run SSIS packages by using Azure SQL Managed Instance Agent
3+
description: Learn how to run SSIS packages by using Azure SQL Managed Instance Agent.
44
services: data-factory
55
documentationcenter: ''
66
ms.service: data-factory
@@ -11,85 +11,101 @@ author: lle
1111
ms.date: 04/14/2020
1212
---
1313

14-
# Execute SSIS packages by Azure SQL Managed Instance Agent
15-
This article describes how to run a SQL Server Integration Services (SSIS) package by using Azure SQL Managed Instance Agent. This feature provides similar behaviors just like when you schedule SSIS packages by SQL Server Agent in your on-prem environment.
14+
# Run SSIS packages by using Azure SQL Managed Instance Agent
15+
This article describes how to run a SQL Server Integration Services (SSIS) package by using Azure SQL Managed Instance Agent. This feature provides behaviors that are similar to when you schedule SSIS packages by using SQL Server Agent in your on-premises environment.
1616

17-
With this feature, you can run SSIS packages that are stored in SSISDB of Azure SQL Managed Instance or File System such as Azure Files.
17+
With this feature, you can run SSIS packages that are stored in SSISDB in Azure SQL Managed Instance or a file system like Azure Files.
1818

1919
## Prerequisites
20-
To use this feature, download and install the latest version of SSMS, which is version 18.5 or later. Download it from [this website](https://docs.microsoft.com/sql/ssms/download-sql-server-management-studio-ssms?view=sql-server-2017).
20+
To use this feature, [download](https://docs.microsoft.com/sql/ssms/download-sql-server-management-studio-ssms?view=sql-server-2017) and install the latest version of SQL Server Management Studio (SSMS), which is version 18.5 or later.
2121

22-
And you need to provision an Azure-SSIS Integration Runtime in Azure Data Factory, which uses Azure SQL Managed Instance as endpoint server. If you have not provisioned it already, provision it by following instructions in the [tutorial](tutorial-create-azure-ssis-runtime-portal.md).
22+
You also need to [provision an Azure-SSIS integration runtime](tutorial-create-azure-ssis-runtime-portal.md) in Azure Data Factory. It uses Azure SQL Managed Instance as an endpoint server.
23+
24+
## Run an SSIS package in SSISDB
25+
In this procedure, you use Azure SQL Managed Instance Agent to invoke an SSIS package that's stored in SSISDB.
2326

24-
## Run SSIS packages in SSISDB by Azure SQL Managed Instance Agent
25-
In this step, you use Azure SQL Managed Instance Agent to invoke SSIS packages that is stored in SSISDB in Azure SQL Managed Instance.
2627
1. In the latest version of SSMS, connect to Azure SQL Managed Instance.
27-
2. Create a new Agent Job and a new Job step.
28+
1. Create a new agent job and a new job step. Under **SQL Server Agent**, right-click the **Jobs** folder, and then select **New Job**.
29+
30+
![Selections for creating a new agent job](./media/how-to-invoke-ssis-package-managed-instance-agent/new-agent-job.png)
2831

29-
![New Agent Job](./media/how-to-invoke-ssis-package-managed-instance-agent/new-agent-job.png)
32+
1. On the **New Job Step** page, select **SQL Server Integration Services Package** as the type.
3033

31-
3. In the **New Job Step** page, choose **SQL Server Integration Services Package** type.
34+
![Selections for creating a new SSIS job step](./media/how-to-invoke-ssis-package-managed-instance-agent/new-ssis-job-step.png)
3235

33-
![New SSIS Job step](./media/how-to-invoke-ssis-package-managed-instance-agent/new-ssis-job-step.png)
36+
1. On the **Package** tab, select **SSIS Catalog** as the package source type.
37+
1. Because SSISDB is in Azure SQL Managed Instance, you don't need to specify authentication.
38+
1. Specify an SSIS package from SSISDB.
3439

35-
4. In the **Package** tab, choose **SSIS Catalog** as package source type.
36-
5. Because the SSISDB is in the same Azure SQL Managed Instance, you don't need to specify authentication.
37-
6. Specify an SSIS package from your SSISDB.
40+
![Package tab with selections for the package source type](./media/how-to-invoke-ssis-package-managed-instance-agent/package-source-ssisdb.png)
3841

39-
![Package Source Type - SSIS Catalog](./media/how-to-invoke-ssis-package-managed-instance-agent/package-source-ssisdb.png)
42+
1. On the **Configuration** tab, you can:
43+
44+
- Specify parameter values under **Parameters**.
45+
- Override values under **Connection Managers**.
46+
- Override the property and choose the logging level under **Advanced**.
4047

41-
7. In the **Configurations** tab, you can specify **parameter** values, override values in **Connection Managers**, override **Property** and choose **Logging level**.
48+
![Configuration tab with selections for the package source type](./media/how-to-invoke-ssis-package-managed-instance-agent/package-source-ssisdb-configuration.png)
4249

43-
![Package Source Type - SSIS Catalog Configuration](./media/how-to-invoke-ssis-package-managed-instance-agent/package-source-ssisdb-configuration.png)
50+
1. Select **OK** to save the agent job configuration.
51+
1. Start the agent job to run the SSIS package.
4452

45-
8. After you finished all configuration above, click **OK** to save the Agent Job configuration.
46-
9. Start the Agent Job to execute the SSIS package.
4753

54+
## Run an SSIS package in the file system
55+
In this procedure, you use Azure SQL Managed Instance Agent to run an SSIS package that's stored in the file system.
4856

49-
## Run SSIS packages in file system by Azure SQL managed instance agent
50-
In this step, you use Azure SQL Managed Instance Agent to invoke SSIS packages that is stored in File System to run.
5157
1. In the latest version of SSMS, connect to Azure SQL Managed Instance.
52-
2. Create a new Agent Job and a new Job step.
58+
1. Create a new agent job and a new job step. Under **SQL Server Agent**, right-click the **Jobs** folder, and then select **New Job**.
59+
60+
![Selections for creating a new agent job](./media/how-to-invoke-ssis-package-managed-instance-agent/new-agent-job.png)
61+
62+
1. On the **New Job Step** page, select **SQL Server Integration Services Package** as the type.
5363

54-
![New Agent Job](./media/how-to-invoke-ssis-package-managed-instance-agent/new-agent-job.png)
64+
![Selections for creating a new SSIS job step](./media/how-to-invoke-ssis-package-managed-instance-agent/new-ssis-job-step.png)
5565

56-
3. In the **New Job Step** page, choose **SQL Server Integration Services Package** type.
66+
1. On the **Package** tab:
5767

58-
![New SSIS Job step](./media/how-to-invoke-ssis-package-managed-instance-agent/new-ssis-job-step.png)
68+
1. For **Package source**, select **File system**.
69+
70+
1. For **File source type**:
5971

60-
4. In the **Package** tab, choose **File system** as package source type.
72+
- If your package is uploaded to Azure Files, select **Azure file share**.
6173

62-
![Package Source Type - File System](./media/how-to-invoke-ssis-package-managed-instance-agent/package-source-file-system.png)
74+
![Options for file source type](./media/how-to-invoke-ssis-package-managed-instance-agent/package-source-file-system.png)
75+
76+
The package path is **\\<storage account name>.file.core.windows.net\<file share name>\<package name>.dtsx**.
77+
78+
Under **Package file access credential**, enter the Azure file account name and account key to access the Azure file. The domain is set as **Azure**.
6379

64-
1. If your package is uploaded to Azure File, choose **Azure file share** as file source type.
65-
- The package path is **\\<storage account name>.file.core.windows.net\<file share name>\<package name>.dtsx**
66-
- Type in the Azure file account name and account key in **Package file access credential** to access the Azure file. The domain is set as **Azure**.
67-
2. If your package is uploaded to a network share, choose **Network share** as file source type.
68-
- The package path is the **UNC path** of your package file with its dtsx extension.
69-
- Type in corresponding **domain**, **username**, and **password** to access the network share package file.
70-
3. If your package file is encrypted with password, select **Encryption password** and type in the password.
80+
- If your package is uploaded to a network share, select **Network share**.
81+
82+
The package path is the **UNC path** of your package file with its .dtsx extension.
83+
84+
Enter the corresponding domain, username, and password to access the network share package file.
85+
1. If your package file is encrypted with a password, select **Encryption password** and enter the password.
86+
1. On the **Configurations** tab, enter the configuration file path if you need a configuration file to run the SSIS package.
87+
1. On the **Execution options** tab, you can choose whether to use **Windows authentication** or **32-bit runtime** to run the SSIS package.
88+
1. On the **Logging** tab, you can choose the logging path and corresponding logging access credential to store the log files. By default, the logging path is the same as the package folder path, and the logging access credential is the same as the package access credential.
89+
1. On the **Set values** tab, you can enter the property path and value to override the package properties.
90+
91+
For example, to override the value of your user variable, enter its path in the following format: **\Package.Variables[User::<variable name>].Value**.
92+
1. Select **OK** to save the agent job configuration.
93+
1. Start the agent job to run the SSIS package.
7194

72-
5. In the **Configurations** tab, type the **configuration file path** if your need a configuration file to execute the SSIS package.
73-
6. In the **Execution options** tab, you can choose whether to use **windows authentication** or **32-bit runtime** to execute the SSIS package.
74-
7. In the **Logging** tab, you can choose the **logging path** and corresponding logging access credential to store the log files. By default, the logging path will be the same as the package folder path and the logging access credential will be the same as the package access credential.
75-
8. In the **Set values** tab, you can type in the **Property Path** and **Value** to override the package properties.
76-
For example, to override the value of your user variable, enter its path in the following format: **\Package.Variables[User::<variable name>].Value**.
77-
9. After you finished all configuration above, click **OK** to save the Agent Job configuration.
78-
10. Start the Agent Job to execute the SSIS package.
7995

96+
## Cancel SSIS package execution
97+
To cancel package execution from an Azure SQL Managed Agent job, take the following steps instead of directly stopping the agent job.
8098

81-
## Cancel SSIS package execution
82-
To cancel package execution from an Azure SQL Managed Agent job, you should follow below steps instead of directly stopping the agent job.
83-
1. Find your SQL agent **jobId** from **msdb.dbo.sysjobs**.
84-
2. Find corresponding SSIS **executionId** based on the job ID by below query:
85-
```sql
86-
select * from ssisdb.internal.execution_parameter_values_noncatalog where parameter_value = 'SQL_Agent_Job_{jobId}' order by execution_id desc
87-
```
88-
3. Select **Active Operations** under SSIS catalog.
99+
1. Find your SQL agent **jobId** from **msdb.dbo.sysjobs**.
100+
1. Find the corresponding SSIS **executionId** based on the job ID, by using this query:
101+
```sql
102+
select * from ssisdb.internal.execution_parameter_values_noncatalog where parameter_value = 'SQL_Agent_Job_{jobId}' order by execution_id desc
103+
```
104+
1. Right-click the SSISDB catalog, and then select **Active Operations**.
89105

90-
![Package Source Type - File System](./media/how-to-invoke-ssis-package-managed-instance-agent/catalog-active-operations.png)
106+
!["Active Operations" on the shortcut menu for the SSISDB catalog](./media/how-to-invoke-ssis-package-managed-instance-agent/catalog-active-operations.png)
91107

92-
4. Stop corresponding operation based on **executionId**.
108+
1. Stop the corresponding operation based on **executionId**.
93109

94110
## Next steps
95-
You can also schedule SSIS packages using Azure Data Factory. For step-by-step instructions, see [Azure Data Factory Event Trigger](how-to-create-event-trigger.md).
111+
You can also schedule SSIS packages by using Azure Data Factory. For step-by-step instructions, see [Azure Data Factory event trigger](how-to-create-event-trigger.md).

0 commit comments

Comments
 (0)