Implementare CI/CD per Analisi di flusso in IoT Edge usando le API

Articolo
06/01/2023

È possibile abilitare l'integrazione e la distribuzione continua per i processi di Analisi di flusso di Azure usando le API REST. Questo articolo fornisce esempi sulle API da usare e come usarle. Le API REST non sono supportate in Azure Cloud Shell.

Chiamare le API da ambienti diversi

Le API REST possono essere chiamate sia da Linux che da Windows. I comandi seguenti dimostrano la sintassi corretta per la chiamata API. L'uso specifico delle API verrà descritto nelle sezioni successive di questo articolo.

Linux

Per Linux è possibile usare i comandi Curl o 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

Per Windows, usare 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

Creare un processo ASA in IoT Edge

Per creare un processo di Analisi di flusso, chiamare il metodo PUT usando l'API di Analisi di flusso.

Metodo	URL richiesta
PUT	`https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{resource-group-name}/providers/Microsoft.StreamAnalytics/streamingjobs/{job-name}?api-version=2017-04-01-preview`

Esempio di comando con 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

Esempio di corpo della richiesta 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": { 
            } 
          } 
        } 
      } 
    ] 
  } 
}

Per altre informazioni, vedere la documentazione delle API.

Pubblicare IoT Edge pacchetto

Per pubblicare un processo di Analisi di flusso in IoT Edge, chiamare il metodo POST usando l'API Pubblicazione pacchetti IoT Edge.

Metodo	URL richiesta
POST	`https://management.azure.com/subscriptions/{subscriptionid}/resourceGroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobname}/publishedgepackage?api-version=2017-04-01-preview`

La chiamata precedente all'API pubblicazione pacchetto IoT Edge attiva un'operazione asincrona e restituisce uno stato 202. L'intestazione della risposta del percorso contiene l'URI usato per ottenere lo stato di tale operazione asincrona. Una chiamata all'URI nell'intestazione della posizione restituisce lo stato 202 per indicare che l'operazione asincrona è ancora in corso. Al termine dell'operazione, la chiamata all'URI nell'intestazione della posizione restituisce lo stato 200.

Esempio di una chiamata di pubblicazione del pacchetto IoT Edge usando 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

Dopo aver effettuato la chiamata POST, è prevedibile una risposta con un corpo vuoto. Cercare l'URI nell'intestazione del percorso della risposta e registrarlo per un ulteriore uso.

Esempio dell'URI dall'intestazione della posizione della risposta:

https://management.azure.com/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/Microsoft.StreamAnalytics/StreamingJobs/{resourcename}/OperationResults/{guidAssignedToTheAsynchronousOperation}?api-version=2017-04-01-preview

Attendere da pochi secondi a un paio di minuti prima di effettuare una chiamata all'API il cui URI trovato nell'intestazione del percorso della risposta all'API di pubblicazione del pacchetto IoT Edge e ripetere il ciclo di attesa e ripetizione dei tentativi fino a quando non si riceve una risposta 200.

Esempio di chiamata API con URL restituito con 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 risposta include le informazioni necessarie per aggiungere allo script di distribuzione IoT Edge. Gli esempi seguenti mostrano quali informazioni è necessario raccogliere e dove aggiungerle nel manifesto della distribuzione.

Esempio di corpo della risposta dopo la pubblicazione:

{ 
  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" 
}

Esempio di manifesto della distribuzione:

{ 
  "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>} 
    } 
  } 
}

Dopo aver configurato il manifesto della distribuzione, vedere Distribuire moduli di Azure IoT Edge con l'interfaccia della riga di comando di Azure per la distribuzione.

Condividi tramite