Implementace CI/CD pro Stream Analytics na IoT Edge s využitím rozhraní API
Pro úlohy Azure Stream Analytics můžete povolit kontinuální integraci a nasazování pomocí rozhraní REST API. Tento článek obsahuje příklady, která rozhraní API použít a jak je používat. Rozhraní REST API se v Azure Cloud Shell nepodporují.
Volání rozhraní API z různých prostředí
Rozhraní REST API je možné volat z Linuxu i Windows. Následující příkazy ukazují správnou syntaxi volání rozhraní API. Konkrétní využití rozhraní API bude popsáno v dalších částech tohoto článku.
Linux
Pro Linux můžete použít Curl příkazy nebo Wget :
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
Pro Windows použijte 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
Vytvoření úlohy ASA na IoT Edge
Pokud chcete vytvořit úlohu Stream Analytics, zavolejte metodu PUT pomocí rozhraní API Stream Analytics.
| Metoda | Adresa URL požadavku |
|---|---|
| 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říklad příkazu pomocí příkazu 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
Příklad textu požadavku ve formátu 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": {
}
}
}
}
]
}
}
Další informace najdete v dokumentaci k rozhraní API.
Publikování IoT Edge balíčku
Pokud chcete publikovat úlohu Stream Analytics na IoT Edge, zavolejte metodu POST pomocí rozhraní API pro publikování balíčků IoT Edge.
| Metoda | Adresa URL požadavku |
|---|---|
| POST | https://management.azure.com/subscriptions/{subscriptionid}/resourceGroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobname}/publishedgepackage?api-version=2017-04-01-preview |
Předchozí volání rozhraní API pro publikování balíčku IoT Edge aktivuje asynchronní operaci a vrátí stav 202. Hlavička odpovědi na umístění obsahuje identifikátor URI použitý k získání stavu této asynchronní operace. Volání identifikátoru URI v hlavičce umístění vrátí stav 202, který označuje, že asynchronní operace stále probíhá. Po dokončení operace vrátí volání identifikátoru URI v hlavičce umístění stav 200.
Příklad volání publikování balíčku IoT Edge pomocí 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
Po volání POST byste měli očekávat odpověď s prázdným textem. Vyhledejte identifikátor URI v hlavičce umístění odpovědi a poznamenejte si ho pro další použití.
Příklad identifikátoru URI z hlavičky location odpovědi:
https://management.azure.com/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/StreamingJobs/{resourcename}/OperationResults/{guidAssignedToTheAsynchronousOperation}?api-version=2017-04-01-preview
Počkejte několik sekund až několik minut před voláním rozhraní API, jehož identifikátor URI jste našli v hlavičce umístění odpovědi na rozhraní API pro publikování balíčků IoT Edge, a opakujte cyklus čekání a opakování, dokud nedostanete odpověď 200.
Příklad volání rozhraní API s vrácenou adresou URL s 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
Odpověď obsahuje informace, které potřebujete přidat do skriptu nasazení IoT Edge. Následující příklady ukazují, jaké informace je potřeba shromáždit a kam je přidat do manifestu nasazení.
Ukázkový text odpovědi po úspěšném publiková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"
}
Ukázka manifestu nasazení:
{
"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>}
}
}
}
Po konfiguraci manifestu nasazení si projděte téma Nasazení modulů Azure IoT Edge pomocí Azure CLI pro nasazení.