CI/CD voor Stream Analytics op IoT Edge implementeren met behulp van API's
U kunt continue integratie en implementatie inschakelen voor Azure Stream Analytics-taken met behulp van REST API's. Dit artikel bevat voorbeelden van welke API's u moet gebruiken en hoe u deze kunt gebruiken. REST API's worden niet ondersteund in Azure Cloud Shell.
API's aanroepen vanuit verschillende omgevingen
REST API's kunnen worden aangeroepen vanuit zowel Linux als Windows. De volgende opdrachten demonstreren de juiste syntaxis voor de API-aanroep. Specifiek API-gebruik wordt beschreven in latere secties van dit artikel.
Linux
Voor Linux kunt u de opdrachten of Wget gebruikenCurl:
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
Voor Windows gebruikt u PowerShell:
$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
Een ASA-taak maken op IoT Edge
Als u een Stream Analytics-taak wilt maken, roept u de PUT-methode aan met behulp van de Stream Analytics-API.
| Methode | Aanvraag-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 |
Voorbeeld van een opdracht met behulp van 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
Voorbeeld van aanvraagbody in JSON:
{
"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": {
}
}
}
}
]
}
}
Zie de API-documentatie voor meer informatie.
IoT Edge-pakket publiceren
Als u een Stream Analytics-taak op IoT Edge wilt publiceren, roept u de POST-methode aan met behulp van de IoT Edge Package Publish-API.
| Methode | Aanvraag-URL |
|---|---|
| POST | https://management.azure.com/subscriptions/{subscriptionid}/resourceGroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobname}/publishedgepackage?api-version=2017-04-01-preview |
De vorige aanroep van de api voor het publiceren van IoT Edge-pakketten activeert een asynchrone bewerking en retourneert de status 202. De header van het locatieantwoord bevat de URI die wordt gebruikt om de status van die asynchrone bewerking op te halen. Een aanroep van de URI in de locatieheader retourneert de status 202 om aan te geven dat de asynchrone bewerking nog steeds wordt uitgevoerd. Wanneer de bewerking is voltooid, retourneert de aanroep van de URI in de locatieheader de status 200.
Voorbeeld van een IoT Edge pakket publicatieaanroep met behulp van curl:
curl -d -X POST https://management.azure.com/subscriptions/{subscriptionid}/resourceGroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobname}/publishedgepackage?api-version=2017-04-01-preview
Nadat u de POST-aanroep hebt uitgevoerd, moet u een antwoord met een lege hoofdtekst verwachten. Zoek de URI in de locatieheader van het antwoord en noteer deze voor verder gebruik.
Voorbeeld van de URI van de locatieheader van het antwoord:
https://management.azure.com/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/StreamingJobs/{resourcename}/OperationResults/{guidAssignedToTheAsynchronousOperation}?api-version=2017-04-01-preview
Wacht een paar seconden tot een paar minuten voordat u de API aanroept waarvan u de URI hebt gevonden in de locatieheader van het antwoord op de IoT Edge Pakket publiceren-API en herhaal de cyclus van wachten en opnieuw proberen totdat u een 200-antwoord krijgt.
Voorbeeld van het maken van EEN API-aanroep met de geretourneerde URL met curl:
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
Het antwoord bevat de informatie die u moet toevoegen aan het IoT Edge-implementatiescript. In de onderstaande voorbeelden ziet u welke informatie u moet verzamelen en waar u deze kunt toevoegen aan het implementatiemanifest.
Voorbeeld van antwoordtekst na publicatie:
{
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"
}
Voorbeeld van implementatiemanifest:
{
"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>}
}
}
}
Nadat u het implementatiemanifest hebt geconfigureerd, raadpleegt u Azure IoT Edge-modules implementeren met Azure CLI voor implementatie.