CI/CD implementálása a Stream Analyticshez IoT Edge API-k használatával
Rest API-k használatával engedélyezheti a folyamatos integrációt és üzembe helyezést az Azure Stream Analytics-feladatokhoz. Ez a cikk példákat tartalmaz a használandó API-kra és azok használatára. A REST API-k nem támogatottak az Azure Cloud Shell.
API-k meghívása különböző környezetekből
A REST API-k Linuxról és Windowsról is meghívhatók. Az alábbi parancsok az API-hívás megfelelő szintaxisát mutatják be. Az API-használatot a cikk későbbi szakaszai ismertetik.
Linux
Linux esetén a vagy Wget parancsokat használhatjaCurl:
curl -u { <username:password> } -H "Content-Type: application/json" -X { <method> } -d "{ <request body> }" { <url> }
wget -q -O- --{ <method> } -data="<request body>" --header=Content-Type:application/json --auth-no-challenge --http-user="<Admin>" --http-password="<password>" <url>
Windows
Windows esetén használja a PowerShellt:
$user = "<username>"
$pass = "<password>"
$encodedCreds = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $user,$pass)))
$basicAuthValue = "Basic $encodedCreds"
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Content-Type", 'application/json')
$headers.Add("Authorization", $basicAuthValue)
$content = "<request body>"
$response = Invoke-RestMethod <url> -Method <method> -Body $content -Headers $Headers
echo $response
ASA-feladat létrehozása IoT Edge
Stream Analytics-feladat létrehozásához hívja meg a PUT metódust a Stream Analytics API használatával.
| Metódus | URL-cím kérése |
|---|---|
| PUT | https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{resource-group-name}/providers/Microsoft.StreamAnalytics/streamingjobs/{job-name}?api-version=2017-04-01-preview |
Példa parancsra a curl használatával:
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
Példa a kérelemtörzsre a JSON-ban:
{
"location": "West US",
"tags": { "key": "value", "ms-suppressjobstatusmetrics": "true" },
"sku": {
"name": "Standard"
},
"properties": {
"sku": {
"name": "standard"
},
"eventsLateArrivalMaxDelayInSeconds": 1,
"jobType": "edge",
"inputs": [
{
"name": "{inputname}",
"properties": {
"type": "stream",
"serialization": {
"type": "JSON",
"properties": {
"fieldDelimiter": ",",
"encoding": "UTF8"
}
},
"datasource": {
"type": "GatewayMessageBus",
"properties": {
}
}
}
}
],
"transformation": {
"name": "{queryName}",
"properties": {
"query": "{query}"
}
},
"package": {
"storageAccount" : {
"accountName": "{blobstorageaccountname}",
"accountKey": "{blobstorageaccountkey}"
},
"container": "{blobcontaine}]"
},
"outputs": [
{
"name": "{outputname}",
"properties": {
"serialization": {
"type": "JSON",
"properties": {
"fieldDelimiter": ",",
"encoding": "UTF8"
}
},
"datasource": {
"type": "GatewayMessageBus",
"properties": {
}
}
}
}
]
}
}
További információkért tekintse meg az API dokumentációját.
IoT Edge csomag közzététele
Stream Analytics-feladat IoT Edge való közzétételéhez hívja meg a POST metódust a IoT Edge Package Publish API használatával.
| Metódus | URL-cím kérése |
|---|---|
| POST | https://management.azure.com/subscriptions/{subscriptionid}/resourceGroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobname}/publishedgepackage?api-version=2017-04-01-preview |
A IoT Edge Package Publish API előző hívása egy aszinkron műveletet aktivál, és 202-et ad vissza. A hely válaszfejléce tartalmazza az aszinkron művelet állapotának lekéréséhez használt URI-t. A helyfejléc URI-hívása 202-s állapotot ad vissza, amely jelzi, hogy az aszinkron művelet még folyamatban van. Ha a művelet befejeződött, a helyfejléc URI-jának hívása 200-nak ad vissza állapotot.
Példa egy IoT Edge-csomag közzétételi hívására a curl használatával:
curl -d -X POST https://management.azure.com/subscriptions/{subscriptionid}/resourceGroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobname}/publishedgepackage?api-version=2017-04-01-preview
A POST hívás végrehajtása után egy üres törzsű válaszra kell számítania. Keresse meg az URI-t a válasz helyfejlécében, és jegyezze fel további használatra.
Példa a válasz helyfejlécéből származó URI-ra:
https://management.azure.com/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/StreamingJobs/{resourcename}/OperationResults/{guidAssignedToTheAsynchronousOperation}?api-version=2017-04-01-preview
Várjon néhány másodperctől néhány percig, mielőtt hívást kezdeményez a IoT Edge Package Publish API-ra adott válasz helyfejlécében található URI-val, majd ismételje meg a várakozási és újrapróbálkozási ciklust, amíg 200-ra nem kap választ.
Példa API-hívás indítására a visszaadott URL-címmel a curl használatával:
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
A válasz tartalmazza a IoT Edge üzembehelyezési szkripthez hozzáadandó információkat. Az alábbi példák azt mutatják be, hogy milyen adatokat kell összegyűjtenie, és hol kell felvennie azokat az üzembehelyezési jegyzékbe.
Mintaválasz törzse a sikeres közzététel után:
{
edgePackageUrl : null
error : null
manifest : "{"supportedPlatforms":[{"os":"linux","arch":"amd64","features":[]},{"os":"linux","arch":"arm","features":[]},{"os":"windows","arch":"amd64","features":[]}],"schemaVersion":"2","name":"{jobname}","version":"1.0.0.0","type":"docker","settings":{"image":"{imageurl}","createOptions":null},"endpoints":{"inputs":["\],"outputs":["{outputnames}"]},"twin":{"contentType":"assignments","content":{"properties.desired":{"ASAJobInfo":"{asajobsasurl}","ASAJobResourceId":"{asajobresourceid}","ASAJobEtag":"{etag}","PublishTimeStamp":"{publishtimestamp}"}}}}"
status : "Succeeded"
}
Példa az üzembehelyezési jegyzékre:
{
"modulesContent": {
"$edgeAgent": {
"properties.desired": {
"schemaVersion": "1.0",
"runtime": {
"type": "docker",
"settings": {
"minDockerVersion": "v1.25",
"loggingOptions": "",
"registryCredentials": {}
}
},
"systemModules": {
"edgeAgent": {
"type": "docker",
"settings": {
"image": "mcr.microsoft.com/azureiotedge-agent:1.0",
"createOptions": "{}"
}
},
"edgeHub": {
"type": "docker",
"status": "running",
"restartPolicy": "always",
"settings": {
"image": "mcr.microsoft.com/azureiotedge-hub:1.0",
"createOptions": "{}"
}
}
},
"modules": {
"<asajobname>": {
"version": "1.0",
"type": "docker",
"status": "running",
"restartPolicy": "always",
"settings": {
"image": "<settings.image>",
"createOptions": "<settings.createOptions>"
}
"version": "<version>",
"env": {
"PlanId": {
"value": "stream-analytics-on-iot-edge"
}
}
}
},
"$edgeHub": {
"properties.desired": {
"schemaVersion": "1.0",
"routes": {
"route": "FROM /* INTO $upstream"
},
"storeAndForwardConfiguration": {
"timeToLiveSecs": 7200
}
}
},
"<asajobname>": {
"properties.desired": {<twin.content.properties.desired>}
}
}
}
Az üzembehelyezési jegyzék konfigurálása után tekintse meg az Azure IoT Edge-modulok üzembe helyezéséhez az Azure CLI-vel történő üzembe helyezését ismertető témakört.