Skip to content

Commit 80159ec

Browse files
authored
Merge pull request #222518 from alexlzx/branch1227
update CICD and VSCode related docs
2 parents 915cf2c + 2d2d7bc commit 80159ec

11 files changed

+93
-105
lines changed

articles/stream-analytics/cicd-overview.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,30 @@
22
title: Continuous integration and deployment for Azure Stream Analytics
33
description: This article gives an overview of a continuous integration and deployment (CI/CD) pipeline for Azure Stream Analytics.
44
services: stream-analytics
5-
author: su-jie
6-
ms.author: sujie
5+
author: alexlzx
6+
ms.author: zhenxilin
77
ms.service: stream-analytics
88
ms.topic: how-to
9-
ms.date: 9/22/2020
9+
ms.date: 12/27/2022
1010
---
1111

1212
# Continuous integration and deployment (CI/CD) for Azure Stream Analytics
1313

14-
You can deploy your Azure Stream Analytics job continuously by using source control integration. Source control integration enables a workflow in which a code update triggers a resource deployment to Azure. This article outlines the basic steps for creating a continuous integration and deployment (CI/CD) pipeline.
14+
You can build and deploy your Azure Stream Analytics (ASA) job continuously using a source control integration. Source control integration creates a workflow in which updating code would trigger a resource deployment to Azure. This article outlines the basic steps for creating a continuous integration and continuous delivery (CI/CD) pipeline.
1515

1616
If you're new to Azure Stream Analytics, get started with the [Azure Stream Analytics quickstart](stream-analytics-quick-create-portal.md).
1717

1818
## Create a CI/CD pipeline
1919

20-
Follow the steps in this guide to create a CI/CD pipeline for Stream Analytics.
20+
Follow the steps to create a CI/CD pipeline for your Stream Analytics project:
2121

22-
1. Develop an Azure Stream Analytics query.
22+
1. Create a Stream Analytics project using VSCode.
23+
24+
You can either create a new project or export an existing job to your computer using the ASA Tools extension for Visual Studio Code. Check out these two docs for more information:
25+
* [Quickstart: Create a Stream Analytics job using VSCode](./quick-create-visual-studio-code.md)
26+
* [Export an existing job](visual-studio-code-explore-jobs.md#export-a-job-to-a-local-project)
2327

24-
Use Azure Stream Analytics tools for [Visual Studio Code](./quick-create-visual-studio-code.md) or [Visual Studio](stream-analytics-quick-create-vs.md) to [develop and test queries locally](develop-locally.md). You can also [export an existing job](visual-studio-code-explore-jobs.md#export-a-job-to-a-local-project) to a local project.
25-
26-
> [!NOTE]
27-
> We strongly recommend using [**Stream Analytics tools for Visual Studio Code**](./quick-create-visual-studio-code.md) for best local development experience. There are known feature gaps in Stream Analytics tools for Visual Studio 2019 (version 2.6.3000.0) and it won't be improved going forward.
28-
29-
2. Commit your Azure Stream Analytics projects to your source control system, like a Git repository.
28+
2. Commit your Stream Analytics project to your source control system, like a Git repository.
3029

3130
3. Use [Azure Stream Analytics CI/CD tools](cicd-tools.md) to build the projects and generate Azure Resource Manager templates for the deployment.
3231

articles/stream-analytics/cicd-tools.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
title: Automate builds, tests, and deployments of an Azure Stream Analytics job using CI/CD tools
33
description: This article describes how to use Azure Stream Analytics CI/CD tools to auto build, test, and deploy an Azure Stream Analytics project.
44
services: stream-analytics
5-
author: su-jie
6-
ms.author: sujie
5+
author: alexlzx
6+
ms.author: zhenxilin
77
ms.service: stream-analytics
88
ms.topic: how-to
9-
ms.date: 06/29/2021
9+
ms.date: 12/27/2022
1010
---
1111

1212
# Automate builds, tests, and deployments of an Azure Stream Analytics job using CI/CD tools
1313

14-
You can use the Azure Stream Analytics CI/CD npm package to automatically build, test, and deploy your Azure Stream Analytics Visual Studio Code or Visual Studio projects. The projects can be created using development tools or they can be exported from existing Stream Analytics jobs. This article describes how to use the npm package with any CI/CD system. For deployment with Azure Pipelines, see [Use Azure DevOps to create a CI/CD pipeline for a Stream Analytics job](set-up-cicd-pipeline.md).
14+
After developing your Stream Analytics project in Visual Studio Code, you can use the Azure Stream Analytics (ASA) CI/CD npm package to automatically build, test, and deploy your Stream Analytics projects. This article shows how to use the npm package with any CI/CD system. For deployment with Azure Pipelines, see [Use Azure DevOps to create a CI/CD pipeline for a Stream Analytics job](set-up-cicd-pipeline.md).
1515

1616
## Installation
1717

@@ -21,7 +21,7 @@ You can [download the package](https://www.npmjs.com/package/azure-streamanalyti
2121

2222
The **asa-streamanalytics-cicd** npm package provides the tools to generate Azure Resource Manager templates of Stream Analytics [Visual Studio Code projects](./quick-create-visual-studio-code.md) or [Visual Studio projects](stream-analytics-quick-create-vs.md). You can also use the npm package on Windows, macOS, and Linux without installing Visual Studio Code or Visual Studio.
2323

24-
Once you have installed the package, use the following command to build your Stream Analytics projects.
24+
Once you've installed the package, use the following command to build your Stream Analytics projects.
2525

2626
```powershell
2727
azure-streamanalytics-cicd build -project <projectFullPath> [-outputPath <outputPath>]
@@ -32,7 +32,7 @@ The *build* command does a keyword syntax check and outputs the Azure Resource M
3232
| Parameter | Description |
3333
|---|---|
3434
| `-project` | The absolute path of the **asaproj.json** file for your Visual Studio Code project or **[Your project name].asaproj** for Visual Studio project. |
35-
| `-outputPath` | The path of the output folder for Azure Resource Manager Templates. If it is not specified, the templates will be placed in the current directory. |
35+
| `-outputPath` | The path of the output folder for Azure Resource Manager Templates. If it isn't specified, the templates will be placed in the current directory. |
3636

3737
#### [Visual Studio Code](#tab/visual-studio-code)
3838

@@ -60,7 +60,7 @@ When a Stream Analytics project builds successfully, it generates the following
6060

6161
The default parameters in the parameters.json file are from the settings in your Visual Studio Code or Visual Studio project. If you want to deploy to another environment, replace the parameters accordingly.
6262

63-
The default values for all credentials are **null**. You are required to set the values before you deploy to Azure.
63+
The default values for all credentials are **null**. You're required to set the values before you deploy to Azure.
6464

6565
```json
6666
"Input_EntryStream_sharedAccessPolicyKey": {
@@ -81,8 +81,8 @@ azure-streamanalytics-cicd localrun -project <projectFullPath> [-outputPath <out
8181
| Parameter | Description |
8282
|---|---|
8383
| `-project` | The path of the **asaproj.json** file for your Visual Studio Code project or **[Your project name].asaproj** for Visual Studio project. |
84-
| `-outputPath` | The path of the output folder. If it is not specified, the output result files will be placed in the current directory. |
85-
| `-customCodeZipFilePath` | The path of the zip file for C# custom code, such as a UDF or deserializer, if they are used. Package the DLLs into a zip file and specify this path. |
84+
| `-outputPath` | The path of the output folder. If it isn't specified, the output result files will be placed in the current directory. |
85+
| `-customCodeZipFilePath` | The path of the zip file for C# custom code, such as a UDF or deserializer, if they're used. Package the DLLs into a zip file and specify this path. |
8686

8787
#### [Visual Studio Code](#tab/visual-studio-code)
8888

@@ -116,7 +116,7 @@ azure-streamanalytics-cicd addtestcase -project <projectFullPath> [-testConfigPa
116116
| Parameter | Description |
117117
|---|---|
118118
| `-project` | The path of the **asaproj.json** file for your Visual Studio Code project or **[Your project name].asaproj** for Visual Studio project. |
119-
| `-testConfigPath` | The path of the test configuration file. If it is not specified, the file will be searched in **\test** under the current directory of the **asaproj.json** file, with default file name **testConfig.json**. A new file will be created if not existed. |
119+
| `-testConfigPath` | The path of the test configuration file. If it isn't specified, the file will be searched in **\test** under the current directory of the **asaproj.json** file, with default file name **testConfig.json**. A new file will be created if not existed. |
120120

121121
> [!NOTE]
122122
> The `Script` value in the generated **testConfig.json** file is only for providing the context; It's not used in the testing logic.
@@ -249,9 +249,9 @@ azure-streamanalytics-cicd test -project <projectFullPath> [-testConfigPath <tes
249249
| Parameter | Description |
250250
|---|---|
251251
| `-project` | The path of the **asaproj.json** file for your Visual Studio Code project or **[Your project name].asaproj** for Visual Studio project. |
252-
| `-testConfigPath` | The path to the test configuration file. If it is not specified, the file will be searched in **\test** under the current directory of the **asaproj.json** file, with default file name **testConfig.json**.
253-
| `-outputPath` | The path of the test result output folder. If it is not specified, the output result files will be placed in the current directory. |
254-
| `-customCodeZipFilePath` | The path of the zip file for custom code such as a UDF or deserializer, if they are used. |
252+
| `-testConfigPath` | The path to the test configuration file. If it isn't specified, the file will be searched in **\test** under the current directory of the **asaproj.json** file, with default file name **testConfig.json**.
253+
| `-outputPath` | The path of the test result output folder. If it isn't specified, the output result files will be placed in the current directory. |
254+
| `-customCodeZipFilePath` | The path of the zip file for custom code such as a UDF or deserializer, if they're used. |
255255

256256
As an example, in a PowerShell enabled terminal, if all test assets are located in a `test` subfolder of the project folder. With each test run output stored in a new timestamped subfolder of a `testResults` subfolder:
257257

articles/stream-analytics/copy-job.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,32 @@
11
---
22
title: Copy, back up and move your Azure Stream Analytics jobs between regions
33
description: This article describes how to move, copy, and back up an Azure Stream Analytics job.
4-
author: su-jie
5-
ms.author: sujie
6-
4+
author: alexlzx
5+
ms.author: zhenxilin
76
ms.service: stream-analytics
87
ms.topic: how-to
98
ms.custom: subject-moving-resources
10-
ms.date: 09/11/2019
9+
ms.date: 12/27/2012
1110
#Customer intent: As an Azure Stream Analytics job developer or admin, I want export my job so that I can reuse, move between Azure regions, or back up.
1211
---
1312

1413
# Copy, back up and move your Azure Stream Analytics jobs between regions
1514

16-
When you want to move, copy or back up your deployed Azure Stream Analytics jobs, you can use the job exporting function in Stream Analytics extension for Visual Studio Code or Visual Studio to achieve. It will help you to export your job's definition to local, then you can backup it there or resubmit it to another region.
15+
If you want to move, copy or back up your Azure Stream Analytics jobs in Azure, the Azure Stream Analytics extension for Visual Studio Code allows you to export an existing job in Azure cloud to your local computer. All the configurations of your Stream Analytics job will be saved locally and you can resubmit it to another cloud region.
1716

1817
> [!NOTE]
19-
> * We strongly recommend using [**Stream Analytics tools for Visual Studio Code**](./quick-create-visual-studio-code.md) for best local development experience. There are known feature gaps in Stream Analytics tools for Visual Studio 2019 (version 2.6.3000.0) and it won't be improved going forward.
2018
> * Copying a job to another region does not copy the last output time. Therefore, you cannot use [**When last stopped**](./start-job.md#start-options) option when starting the copied job.
2119
2220
## Before you begin
2321
* If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/).
2422

2523
* Sign in to the [Azure portal](https://portal.azure.com/).
2624

27-
* Install [Azure Stream Analytics extension for Visual Studio Code](quick-create-visual-studio-code.md#install-the-azure-stream-analytics-tools-extension) or [Azure Stream Analytics tools for Visual Studio](quick-create-visual-studio-code.md#install-the-azure-stream-analytics-tools-extension).
25+
* Install [Azure Stream Analytics extension for Visual Studio Code](quick-create-visual-studio-code.md#install-the-azure-stream-analytics-tools-extension).
2826

2927
## Visual Studio Code
3028

31-
1. Click the **Azure** icon on the Visual Studio Code Activity Bar and then expand **Stream Analytics** node. Your jobs should appear under your subscriptions.
29+
1. Select the **Azure** icon on the Visual Studio Code Activity Bar and then expand **Stream Analytics** node. Your jobs should appear under your subscriptions.
3230

3331
![Open Stream Analytics Explorer](./media/vscode-explore-jobs/open-explorer.png)
3432

@@ -42,13 +40,6 @@ When you want to move, copy or back up your deployed Azure Stream Analytics jobs
4240

4341
![Publish to Azure in Visual Studio Code](./media/quick-create-visual-studio-code/submit-job.png)
4442

45-
## Visual Studio
46-
47-
1. Follow the [export a deployed Azure Stream Analytics job to a project instructions](./stream-analytics-vs-tools.md#export-jobs-to-a-project).
48-
49-
2. Open the \*.asaql file in the Query Editor, select **Submit To Azure** in the script editor and follow the instructions to publish the job to another region or backup using a new name.
50-
5143
## Next steps
5244

53-
* [Quickstart: Create a Stream Analytics job by using Visual Studio Code](quick-create-visual-studio-code.md)
54-
* [Quickstart: Create a Stream Analytics job by using Visual Studio](stream-analytics-quick-create-vs.md)
45+
* [Quickstart: Create a Stream Analytics job by using Visual Studio Code](quick-create-visual-studio-code.md)
Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
title: Develop and debug Azure Stream Analytics jobs locally
33
description: Learn how to develop and test Azure Stream Analytics jobs on your local computer before you run them in Azure portal.
4-
ms.author: sujie
5-
author: su-jie
4+
ms.author: zhenxilin
5+
author: alexlzx
66
ms.topic: conceptual
7-
ms.date: 03/31/2020
7+
ms.date: 12/27/2022
88
ms.service: stream-analytics
99
---
1010

1111
# Develop and debug Azure Stream Analytics jobs locally
1212

13-
While you're able to create and test Azure Stream Analytics jobs in the Azure portal, many developers prefer a local development experience. Stream Analytics makes it easy to use your favorite code editor and development tools to create and test jobs with live event streams from Azure Event Hub, IoT Hub, and Blob Storage using a fully functioned single node local runtime. You can also submit jobs to Azure directly from your local development environment.
13+
Apart from creating and developing an Azure Stream Analytics job in the Azure portal, you can set up a Stream Analytics job using a developer tool on your computer. Azure Stream Analytics (ASA) allows you to use your favorite code editor, e.g., Visual Studio Code to build and test query locally with live data streams from Azure Event Hubs, IoT Hub, Blob Storage and other Azure resources. The ASA developer tool creates a fully functional node in local runtime to run your Stream Analytics job. You can also submit your local Stream Analytics jobs to Azure cloud and change the job running status. Using the ASA developer tool is a convenient way to build, test and manage your Stream Analytics jobs.
1414

1515
## Local development environments
1616

@@ -20,16 +20,10 @@ The environments in the following table support local development:
2020

2121
|Environment |Description |
2222
|-----------------------------------------|------------|
23-
|[Visual Studio Code](visual-studio-code-explore-jobs.md)| The [Azure Stream Analytics Tools extension](https://marketplace.visualstudio.com/items?itemName=ms-bigdatatools.vscode-asa) for Visual Studio Code allows you to author, manage, test your Stream analytics job both locally and in the cloud with rich IntelliSense and native source control. Supports development on Linux, MacOS and Windows. To learn more, see [Create an Azure Stream Analytics job in Visual Studio Code](quick-create-visual-studio-code.md). The extension also supports [Visual Studio Codespaces](https://visualstudio.microsoft.com/services/visual-studio-codespaces/) which is a cloud-hosted dev environment.|
24-
|[Visual Studio 2019](stream-analytics-tools-for-visual-studio-install.md) |Stream Analytics Tools is part of the Azure development and Data storage and processing workloads in Visual Studio. You can use Visual Studio to write custom C# user-defined functions and deserializers. To learn more, see [Create an Azure Stream Analytics job by using Visual Studio](stream-analytics-quick-create-vs.md).|
23+
|[Visual Studio Code](visual-studio-code-explore-jobs.md)| The [Azure Stream Analytics tools extension](https://marketplace.visualstudio.com/items?itemName=ms-bigdatatools.vscode-asa) for Visual Studio Code allows you to author, manage, test your Stream Analytics job both locally and in the cloud with rich IntelliSense and native source control. It supports development on Linux, macOS and Windows. To learn more, see [Create an Azure Stream Analytics job in Visual Studio Code](quick-create-visual-studio-code.md). The extension also supports [Visual Studio Codespaces](https://visualstudio.microsoft.com/services/visual-studio-codespaces/), which is a cloud-hosted dev environment.|
2524
|[Command prompt or terminal](stream-analytics-tools-for-visual-studio-cicd.md)|The Azure Stream Analytics CI/CD NuGet package provides tools for Visual studio project build, local testing on an arbitrary machine. The Azure Stream Analytics CI/CD npm package provides tools for Visual Studio Code project builds (which generates an Azure Resource Manager template) on an arbitrary machine.|
2625

27-
> [!NOTE]
28-
> We strongly recommend using [**Stream Analytics tools for Visual Studio Code**](./quick-create-visual-studio-code.md) for best local development experience. There are known feature gaps in Stream Analytics tools for Visual Studio 2019 (version 2.6.3000.0) and it won't be improved going forward.
29-
3026
## Next steps
3127

3228
* [Test Stream Analytics queries locally with sample data using Visual Studio Code](visual-studio-code-local-run.md)
33-
* [Test Stream Analytics queries locally against live stream input by using Visual Studio Code](visual-studio-code-local-run-live-input.md)
34-
* [Test Stream Analytics queries locally with Visual Studio](stream-analytics-vs-tools-local-run.md)
35-
* [Test live data locally using Azure Stream Analytics tools for Visual Studio](stream-analytics-live-data-local-testing.md)
29+
* [Test Stream Analytics queries locally against live stream input by using Visual Studio Code](visual-studio-code-local-run-live-input.md)

0 commit comments

Comments
 (0)