Implémenter CI/CD pour Stream Analytics sur IoT Edge à l’aide d’API
Vous pouvez activer l’intégration et le déploiement continus pour les tâches Azure Stream Analytics à l’aide d’API REST. Cet article fournit des exemples d’API à utiliser, et explique comment les utiliser. Les API REST ne sont pas prises en charge sur Azure Cloud Shell.
Appeler des API à partir de différents environnements
Vous pouvez appeler des API REST à partir de Linux et Windows. Les commandes suivantes illustrent la syntaxe correcte pour l’appel d’API. L’utilisation spécifique de chaque API est décrite dans les sections suivantes de cet article.
Linux
Pour Linux, vous pouvez utiliser la commande Curl ou 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
Pour Windows, utilisez 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
Créer une tâche ASA sur IoT Edge
Pour créer une tâche Stream Analytics, appelez la méthode PUT à l’aide de l’API Stream Analytics.
| Méthode | URL de demande |
|---|---|
| PUT | https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{resource-group-name}/providers/Microsoft.StreamAnalytics/streamingjobs/{job-name}?api-version=2017-04-01-preview |
Exemple d’utilisation de la commande 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
Exemple de corps de la requête au format 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": {
}
}
}
}
]
}
}
Pour plus d’informations, consultez la documentation de l’API.
Publier le package IoT Edge
Pour publier une tâche Stream Analytics sur IoT Edge, appelez la méthode POST à l’aide de l’API de publication de package IoT Edge.
| Méthode | URL de demande |
|---|---|
| POST | https://management.azure.com/subscriptions/{subscriptionid}/resourceGroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobname}/publishedgepackage?api-version=2017-04-01-preview |
L’appel précédent à l’API de publication de package IoT Edge déclenche une opération asynchrone et retourne l’état 202. L’en-tête de réponse d’emplacement contient l’URI utilisé pour obtenir l’état de cette opération asynchrone. Un appel à l’URI dans l’en-tête d’emplacement retourne l’état 202 pour indiquer que l’opération asynchrone est toujours en cours. Une fois l’opération terminée, l’appel à l’URI dans l’en-tête d’emplacement retourne l’état 200.
Exemple d’appel de publication de package IoT Edge à l’aide de 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
Après avoir effectué l’appel POST, attendez-vous à une réponse avec un corps vide. Recherchez l’URL située dans la tête d’emplacement de la réponse et notez-la pour plus tard.
Exemple d’URI à partir de l’en-tête d’emplacement de la réponse :
https://management.azure.com/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/StreamingJobs/{resourcename}/OperationResults/{guidAssignedToTheAsynchronousOperation}?api-version=2017-04-01-preview
Patientez quelques secondes à quelques minutes avant d’effectuer un appel à l’API dont vous avez trouvé l’URI dans l’en-tête d’emplacement de la réponse à l’API de publication de package IoT Edge, puis répétez le cycle d’attente et de nouvelle tentative jusqu’à obtenir une réponse 200.
Exemple d’appel d’API avec l’URL retournée avec 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
La réponse inclut les informations que vous devez ajouter au script de déploiement IoT Edge. Les exemples ci-dessous illustrent les informations que vous devez recueillir et où les ajouter dans le manifeste du déploiement.
Exemple de corps de réponse une fois la publication réussie :
{
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"
}
Exemple de manifeste de déploiement :
{
"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>}
}
}
}
Après la configuration du manifeste de déploiement, consultez Déployer des modules Azure IoT Edge avec Azure CLI pour plus d’informations sur le déploiement.