Implementar CI/CD para o Stream Analytics no IoT Edge através de APIs
Pode ativar a integração e implementação contínuas para tarefas do Azure Stream Analytics com AS APIs REST. Este artigo fornece exemplos sobre as APIs a utilizar e como utilizá-las. As APIs REST não são suportadas no Azure Cloud Shell.
Chamar APIs de diferentes ambientes
As APIs REST podem ser chamadas a partir do Linux e do Windows. Os seguintes comandos demonstram a sintaxe adequada para a chamada à API. A utilização específica da API será descrita em secções posteriores deste artigo.
Linux
Para Linux, pode utilizar Curl ou Wget comandos:
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
Para Windows, utilize o 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
Criar uma tarefa do ASA no IoT Edge
Para criar uma tarefa do Stream Analytics, chame o método PUT com a API do Stream Analytics.
| Método | URL do Pedido |
|---|---|
| PUT | https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{resource-group-name}/providers/Microsoft.StreamAnalytics/streamingjobs/{job-name}?api-version=2017-04-01-preview |
Exemplo de comando com 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
Exemplo do corpo do pedido em 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": {
}
}
}
}
]
}
}
Para obter mais informações, veja a documentação da API.
Publicar pacote IoT Edge
Para publicar uma tarefa do Stream Analytics no IoT Edge, chame o método POST com a API IoT Edge Package Publish.
| Método | URL do Pedido |
|---|---|
| POST | https://management.azure.com/subscriptions/{subscriptionid}/resourceGroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobname}/publishedgepackage?api-version=2017-04-01-preview |
A chamada anterior à API de Publicação de Pacotes do IoT Edge aciona uma operação assíncrona e devolve um estado de 202. O cabeçalho de resposta de localização contém o URI utilizado para obter o estado dessa operação assíncrona. Uma chamada para o URI no cabeçalho de localização devolve um estado de 202 para indicar que a operação assíncrona ainda está em curso. Quando a operação estiver concluída, a chamada para o URI no cabeçalho da localização devolve um estado de 200.
Exemplo de uma chamada de publicação de pacote de IoT Edge com 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
Depois de fazer a chamada POST, deverá esperar uma resposta com um corpo vazio. Procure o URI no cabeçalho de localização da resposta e registe-o para utilização adicional.
Exemplo do URI do cabeçalho de localização da resposta:
https://management.azure.com/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/StreamingJobs/{resourcename}/OperationResults/{guidAssignedToTheAsynchronousOperation}?api-version=2017-04-01-preview
Aguarde entre alguns segundos e alguns minutos antes de fazer uma chamada à API cujo URI encontrou no cabeçalho de localização da resposta à API de Publicação de Pacotes do IoT Edge e repita o ciclo de espera e repetição até obter uma resposta de 200.
Exemplo de efetuar uma chamada à API com o URL devolvido com 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
A resposta inclui as informações que precisa de adicionar ao script de implementação IoT Edge. Os exemplos abaixo mostram as informações que precisa de recolher e onde adicioná-la no manifesto de implementação.
Corpo da resposta de exemplo após a publicação com êxito:
{
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"
}
Exemplo de Manifesto de Implementação:
{
"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>}
}
}
}
Depois de configurar o manifesto de implementação, veja Implementar módulos do Azure IoT Edge com a CLI do Azure para implementação.