Merge pull request #202791 from JasonWHowell/94696

Pull in public PR 94696

Author: 19BMG00

articles/stream-analytics/stream-analytics-cicd-api.md

@@ -5,7 +5,7 @@ author: su-jie
 ms.author: sujie
 ms.service: stream-analytics
 ms.topic: how-to
-ms.date: 12/04/2018
+ms.date: 06/24/2022
 ---
 
 # Implement CI/CD for Stream Analytics on IoT Edge using APIs
@@ -27,12 +27,12 @@ curl -u { <username:password> }  -H "Content-Type: application/json" -X { <metho
 ```bash
 wget -q -O- --{ <method> } -data="<request body>" --header=Content-Type:application/json --auth-no-challenge --http-user="<Admin>" --http-password="<password>" <url>
 ```
- 
+
 ### Windows
 
-For Windows, use PowerShell: 
+For Windows, use PowerShell:
 
-```powershell 
+```powershell
 $user = "<username>" 
 $pass = "<password>" 
 $encodedCreds = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $user,$pass))) 
@@ -44,21 +44,21 @@ $content = "<request body>"
 $response = Invoke-RestMethod <url> -Method <method> -Body $content -Headers $Headers 
 echo $response 
 ```
- 
-## Create an ASA job on Edge 
- 
+
+## Create an ASA job on IoT Edge
+
 To create Stream Analytics job, call the PUT method using the Stream Analytics API.
 
 |Method|Request URL|
 |------|-----------|
-|PUT|`https://management.azure.com/subscriptions/{\**subscription-id**}/resourcegroups/{**resource-group-name**}/providers/Microsoft.StreamAnalytics/streamingjobs/{**job-name**}?api-version=2017-04-01-preview`|
- 
+|PUT|`https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{resource-group-name}/providers/Microsoft.StreamAnalytics/streamingjobs/{job-name}?api-version=2017-04-01-preview`|
+
 Example of command using **curl**:
 
 ```curl
 curl -u { <username:password> } -H "Content-Type: application/json" -X { <method> } -d "{ <request body> }" https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{resource-group-name}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobname}?api-version=2017-04-01-preview  
-``` 
- 
+```
+
 Example of request body in JSON:
 
 ```json
@@ -129,43 +129,43 @@ Example of request body in JSON:
   } 
 } 
 ```
- 
+
 For more information, see the [API documentation](/rest/api/streamanalytics/).  
- 
-## Publish Edge package 
- 
-To publish a Stream Analytics job on IoT Edge, call the POST method using the Edge Package Publish API.
+
+## Publish IoT Edge package
+
+To publish a Stream Analytics job on IoT Edge, call the POST method using the IoT Edge Package Publish API.
 
 |Method|Request URL|
 |------|-----------|
-|POST|`https://management.azure.com/subscriptions/{\**subscriptionid**}/resourceGroups/{**resourcegroupname**}/providers/Microsoft.StreamAnalytics/streamingjobs/{**jobname**}/publishedgepackage?api-version=2017-04-01-preview`|
+|POST|`https://management.azure.com/subscriptions/{subscriptionid}/resourceGroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobname}/publishedgepackage?api-version=2017-04-01-preview`|
 
-This asynchronous operation returns a status of 202 until the job has been successfully published. The location response header contains the URI used to get the status of the process. While the process is running, a call to the URI in the location header returns a status of 202. When the process finishes, the URI in the location header returns a status of 200. 
+The previous call to the IoT Edge Package Publish API triggers an asynchronous operation and returns a status of 202. The **location** response header contains the URI used to get the status of that asynchronous operation. A call to the URI in the **location** header returns a status of 202 to indicate the asynchronous operation is still in progress. When the operation is completed, the call to the URI in the **location** header returns a status of 200.
 
-Example of an Edge package publish call using **curl**: 
+Example of an IoT Edge package publish call using **curl**:
 
 ```bash
 curl -d -X POST https://management.azure.com/subscriptions/{subscriptionid}/resourceGroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobname}/publishedgepackage?api-version=2017-04-01-preview
 ```
- 
-After making the POST call, you should expect a response with an empty body. Look for the URL located in the HEAD of the response and record it for further use.
- 
-Example of the URL from the HEAD of response:
 
+After making the POST call, you should expect a response with an empty body. Look for the URI in the **location** header of the response, and record it for further use.
+
+Example of the URI from the **location** header of response:
+
+```rest
+https://management.azure.com/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/StreamingJobs/{resourcename}/OperationResults/{guidAssignedToTheAsynchronousOperation}?api-version=2017-04-01-preview
 ```
-https://management.azure.com/subscriptions/{**subscriptionid**}/resourcegroups/{**resourcegroupname**}/providers/Microsoft.StreamAnalytics/StreamingJobs/{**resourcename**}/OperationResults/023a4d68-ffaf-4e16-8414-cb6f2e14fe23?api-version=2017-04-01-preview 
-```
-A 
-Wait for one to two minutes before running the following command to make an API call with the URL you found in the HEAD of the response. Retry the command if you do not get a 200 response.
- 
+
+Wait from a few seconds to a couple of minutes before making a call to the API whose URI you found in the **location** header of the response to the IoT Edge Package Publish API, and repeat the cycle of waiting and retrying until you get a 200 response.
+
 Example of making API call with returned URL with **curl**:
 
 ```bash
-curl -d –X GET https://management.azure.com/subscriptions/{subscriptionid}/resourceGroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/streamingjobs/{resourcename}/publishedgepackage?api-version=2017-04-01-preview 
+curl -d –X GET https://management.azure.com/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/StreamingJobs/{resourcename}/OperationResults/{guidAssignedToTheAsynchronousOperation}?api-version=2017-04-01-preview
 ```
 
-The response includes the information you need to add to the Edge deployment script. The examples below show what information you need to collect and where to add it in the deployment manifest.
- 
+The response includes the information you need to add to the IoT Edge deployment script. The examples below show what information you need to collect and where to add it in the deployment manifest.
+
 Sample response body after publishing successfully:
 
 ```json
@@ -177,7 +177,7 @@ Sample response body after publishing successfully:
 } 
 ```
 
-Sample of Deployment Manifest: 
+Sample of Deployment Manifest:
 
 ```json
 { 
@@ -247,11 +247,10 @@ Sample of Deployment Manifest:
 } 
 ```
 
-After the configuration of the deployment manifest, refer to [Deploy Azure IoT Edge modules with Azure CLI](../iot-edge/how-to-deploy-modules-cli.md) for deployment.
+After you configure the deployment manifest, refer to [Deploy Azure IoT Edge modules with Azure CLI](../iot-edge/how-to-deploy-modules-cli.md) for deployment.
 
+## Next steps
 
-## Next steps 
- 
 * [Azure Stream Analytics on IoT Edge](stream-analytics-edge.md)
 * [ASA on IoT Edge tutorial](../iot-edge/tutorial-deploy-stream-analytics.md)
-* [Develop Stream Analytics Edge jobs using Visual Studio tools](stream-analytics-tools-for-visual-studio-edge-jobs.md)
+* [Develop Stream Analytics IoT Edge jobs using Visual Studio tools](stream-analytics-tools-for-visual-studio-edge-jobs.md)