API を使用して IoT Edge 上に Stream Analytics 向けの CI/CD を実装する

[アーティクル]
06/01/2023

REST API を使用して Azure Stream Analytics ジョブのための継続的インテグレーションと継続的なデプロイを有効にすることができます。この記事では、使用する API とその使用方法の例を示します。 REST API は、Azure Cloud Shell ではサポートされていません。

異なる環境から API を呼び出す

REST API は、Linux と Windows の両方から呼び出すことができます。次のコマンドでは、API 呼び出しの正しい構文を示します。 API の具体的な使用方法は、この記事の後のセクションで説明します。

Linux

Linux では、Curl または 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

Windows では、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

IoT Edge で ASA ジョブを作成する

Stream Analytics ジョブを作成するには、Stream Analytics API を使用して PUT メソッドを呼び出します。

Method	要求 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`

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

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

詳しくは、API のドキュメントをご覧ください。

IoT Edge パッケージを発行する

IoT Edge で Stream Analytics ジョブを発行するには、IoT Edge Package Publish API を使用して POST メソッドを呼び出します。

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

IoT Edge Package Publish API への前の呼び出しでは、非同期操作をトリガーし、状態 202 が返されます。 location 応答ヘッダーには、非同期操作の状態を取得するために使用する URI が含まれます。 location ヘッダー内の URI の呼び出しでは、非同期操作がまだ進行中であることを示す 202 の状態が返されます。操作が完了すると、location ヘッダーの URI の呼び出しでは、状態 200 が返されます。

curl を使用した IoT Edge パッケージ発行呼び出しの例:

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

POST 呼び出しを行った後は、本文が空の応答を予期する必要があります。応答の location ヘッダーにある URL を検索し、後で使用するために記録します。

応答の location ヘッダーからの URI の例:

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

数秒から数分待ってから、IoT Edge Package Publish API への応答の location ヘッダーで URI を見つけた API を呼び出し、200 応答が返されるまで待機と再試行のサイクルを繰り返します。

curl を使用した返された URL での API 呼び出しの例:

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

応答には、IoT Edge のデプロイスクリプトに追加する必要がある情報が含まれます。次の例では、収集する必要がある情報と、配置マニフェストでそれを追加する場所を示します。

正常に発行した後の応答本文のサンプル:

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

配置マニフェストの例:

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

配置マニフェストを構成した後は、デプロイに関する「Azure CLI を使用して Azure IoT Edge モジュールをデプロイする」をご覧ください。

次の方法で共有

API を使用して IoT Edge 上に Stream Analytics 向けの CI/CD を実装する

異なる環境から API を呼び出す

Linux

Windows

IoT Edge で ASA ジョブを作成する

IoT Edge パッケージを発行する

次のステップ

フィードバック

その他のリソース