次の方法で共有


Streaming Jobs - Create Or Replace

ストリーミング ジョブを作成するか、既存のストリーミング ジョブを置き換えます。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}?api-version=2020-03-01

URI パラメーター

名前 / 必須 説明
jobName
path True

string

ストリーミング ジョブの名前。

resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

正規表現パターン: ^[-\w\._\(\)]+$

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

api-version
query True

string

この操作に使用する API バージョン。

要求ヘッダー

名前 必須 説明
If-Match

string

ストリーミング ジョブの ETag。 現在のレコード セットを常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。

If-None-Match

string

新しいストリーミング ジョブを作成できるようにするが、既存のレコード セットを更新できないようにするには、'*' に設定します。 その他の値を指定すると、412 の事前条件失敗応答が発生します。

要求本文

名前 説明
identity

Identity

入力と出力で認証するために使用できる、このジョブに割り当てられたシステム割り当てマネージド ID について説明します。

location

string

リソースが保存されている地理的な場所

properties.cluster

ClusterInfo

ストリーミング ジョブが実行されるクラスター。

properties.compatibilityLevel

CompatibilityLevel

ストリーミング ジョブの特定のランタイム動作を制御します。

properties.contentStoragePolicy

ContentStoragePolicy

有効な値は JobStorageAccount と SystemAccount です。 JobStorageAccount に設定すると、ユーザーは jobStorageAccount プロパティも指定する必要があります。 .

properties.dataLocale

string

Stream Analytics ジョブのデータ ロケール。 値は、セット https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspxからサポートされている .NET カルチャの名前である必要があります。 何も指定されていない場合は "en-US" になります。

properties.eventsLateArrivalMaxDelayInSeconds

integer

遅れて到達したイベントを含めるための最大許容遅延 (秒)。 サポートされている範囲は -1 から 1814399 (20.23:59:59 日数) までです。-1 は、無期限待機の指定に使用されます。 プロパティがない場合、値 -1 であると解釈されます。

properties.eventsOutOfOrderMaxDelayInSeconds

integer

順序が正しくないイベントの順序を戻すように調整できる最大許容遅延 (秒)。

properties.eventsOutOfOrderPolicy

EventsOutOfOrderPolicy

入力イベント ストリームで正しくない順序で到達したイベントに適用するポリシーを示します。

properties.functions

Function[]

ストリーミング ジョブの 1 つ以上の関数の一覧。 PUT 要求でこのプロパティを指定する場合は、各関数の name プロパティが必要です。 PATCH 操作では、このプロパティを変更できません。 個々の変換に使用できる PATCH API を使用する必要があります。

properties.inputs

Input[]

ストリーミング ジョブへの 1 つ以上の入力の一覧。 PUT 要求でこのプロパティを指定する場合は、各入力の name プロパティが必要です。 PATCH 操作では、このプロパティを変更できません。 個々の入力に使用できる PATCH API を使用する必要があります。

properties.jobStorageAccount

JobStorageAccount

MSI を使用する Azure Storage アカウントに関連付けられているプロパティ

properties.jobType

JobType

ジョブの種類について説明します。 有効なモードは Cloud と 'Edge' です。

properties.outputErrorPolicy

OutputErrorPolicy

出力に到達したが、形式が正しくないため (列値が欠けている、列値の種類やサイズが間違っている)、外部ストレージに書き込めないイベントに適用するポリシーを示します。

properties.outputStartMode

OutputStartMode

このプロパティは、作成時にジョブをすぐに開始する必要がある場合にのみ使用する必要があります。 ジョブが開始されるたびに出力イベント ストリームの開始点を開始するか、outputStartTime プロパティで指定されたカスタム ユーザー タイム スタンプから開始するか、最後のイベント出力時刻から開始するかを示す JobStartTime、CustomTime、または LastOutputEventTime を指定できます。

properties.outputStartTime

string

値は、出力イベント ストリームの開始点を示す、ISO-8601 形式のタイムスタンプか、またはストリーム ジョブが開始されるたびに出力イベント ストリームが開始することを示す Null になります。 outputStartMode が CustomTime に設定されている場合、このプロパティには 値が必要です。

properties.outputs

Output[]

ストリーミング ジョブの 1 つ以上の出力の一覧。 PUT 要求でこのプロパティを指定する場合は、各出力の name プロパティが必要です。 PATCH 操作では、このプロパティを変更できません。 個々の出力に使用できる PATCH API を使用する必要があります。

properties.sku

Sku

ストリーミング ジョブの SKU について説明します。 PUT (CreateOrReplace) 要求で必要です。

properties.transformation

Transformation

ストリーミング ジョブに使用するクエリとストリーミング ユニットの数を示します。 PUT 要求でこのプロパティを指定する場合は、変換の name プロパティが必要です。 PATCH 操作では、このプロパティを変更できません。 個々の変換に使用できる PATCH API を使用する必要があります。

tags

object

リソース タグ。

応答

名前 説明
200 OK

StreamingJob

ストリーミング ジョブが正常に作成または置換されました。

ヘッダー

ETag: string

201 Created

StreamingJob

ストリーミング ジョブが正常に作成または置換されました。

ヘッダー

ETag: string

Other Status Codes

Error

エラー。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

Create a complete streaming job (a streaming job with a transformation, at least 1 input and at least 1 output)
Create a streaming job shell (a streaming job with no inputs, outputs, transformation, or functions)

Create a complete streaming job (a streaming job with a transformation, at least 1 input and at least 1 output)

要求のサンプル

PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804?api-version=2020-03-01

{
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 0,
    "eventsLateArrivalMaxDelayInSeconds": 5,
    "dataLocale": "en-US",
    "compatibilityLevel": "1.0",
    "inputs": [
      {
        "properties": {
          "type": "Stream",
          "datasource": {
            "type": "Microsoft.Storage/Blob",
            "properties": {
              "storageAccounts": [
                {
                  "accountName": "yourAccountName",
                  "accountKey": "yourAccountKey=="
                }
              ],
              "container": "containerName",
              "pathPattern": ""
            }
          },
          "serialization": {
            "type": "Json",
            "properties": {
              "encoding": "UTF8"
            }
          }
        },
        "name": "inputtest"
      }
    ],
    "transformation": {
      "properties": {
        "streamingUnits": 1,
        "query": "Select Id, Name from inputtest"
      },
      "name": "transformationtest"
    },
    "outputs": [
      {
        "properties": {
          "datasource": {
            "type": "Microsoft.Sql/Server/Database",
            "properties": {
              "server": "serverName",
              "database": "databaseName",
              "user": "<user>",
              "password": "userPassword",
              "table": "tableName"
            }
          }
        },
        "name": "outputtest"
      }
    ],
    "functions": []
  },
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  }
}

応答のサンプル

ETag: 87551cc5-1290-4d08-afcd-cdaa92e5ade0
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804",
  "name": "sj7804",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 0,
    "eventsLateArrivalMaxDelayInSeconds": 5,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:11.54Z",
    "compatibilityLevel": "1.0",
    "inputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest",
        "name": "inputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
        "properties": {
          "type": "Stream",
          "datasource": {
            "type": "Microsoft.Storage/Blob",
            "properties": {
              "storageAccounts": [
                {
                  "accountName": "accountName"
                }
              ],
              "container": "containerName",
              "pathPattern": ""
            }
          },
          "serialization": {
            "type": "Json",
            "properties": {
              "encoding": "UTF8"
            }
          },
          "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0"
        }
      }
    ],
    "transformation": {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest",
      "name": "transformationtest",
      "type": "Microsoft.StreamAnalytics/streamingjobs/transformations",
      "properties": {
        "streamingUnits": 1,
        "query": "Select Id, Name from inputtest",
        "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8"
      }
    },
    "functions": [],
    "outputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest",
        "name": "outputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
        "properties": {
          "datasource": {
            "type": "Microsoft.Sql/Server/Database",
            "properties": {
              "server": "serverName",
              "database": "databaseName",
              "table": "tableName",
              "user": "userName"
            }
          },
          "etag": "62097c3c-b503-41ff-a56f-196a9598ab90"
        }
      }
    ]
  }
}
ETag: 87551cc5-1290-4d08-afcd-cdaa92e5ade0
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804",
  "name": "sj7804",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 0,
    "eventsLateArrivalMaxDelayInSeconds": 5,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:11.54Z",
    "compatibilityLevel": "1.0",
    "inputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest",
        "name": "inputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
        "properties": {
          "type": "Stream",
          "datasource": {
            "type": "Microsoft.Storage/Blob",
            "properties": {
              "storageAccounts": [
                {
                  "accountName": "accountName"
                }
              ],
              "container": "containerName",
              "pathPattern": ""
            }
          },
          "serialization": {
            "type": "Json",
            "properties": {
              "encoding": "UTF8"
            }
          },
          "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0"
        }
      }
    ],
    "transformation": {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest",
      "name": "transformationtest",
      "type": "Microsoft.StreamAnalytics/streamingjobs/transformations",
      "properties": {
        "streamingUnits": 1,
        "query": "Select Id, Name from inputtest",
        "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8"
      }
    },
    "functions": [],
    "outputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest",
        "name": "outputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
        "properties": {
          "datasource": {
            "type": "Microsoft.Sql/Server/Database",
            "properties": {
              "server": "serverName",
              "database": "databaseName",
              "table": "tableName",
              "user": "userName"
            }
          },
          "etag": "62097c3c-b503-41ff-a56f-196a9598ab90"
        }
      }
    ]
  }
}

Create a streaming job shell (a streaming job with no inputs, outputs, transformation, or functions)

要求のサンプル

PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59?api-version=2020-03-01

{
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 5,
    "eventsLateArrivalMaxDelayInSeconds": 16,
    "dataLocale": "en-US",
    "compatibilityLevel": "1.0",
    "inputs": [],
    "outputs": [],
    "functions": []
  },
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  }
}

応答のサンプル

ETag: 3e6872bc-c9d0-45b6-91b6-da66f1773056
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59",
  "name": "sj59",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 5,
    "eventsLateArrivalMaxDelayInSeconds": 16,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:04.697Z",
    "compatibilityLevel": "1.0",
    "inputs": [],
    "functions": [],
    "outputs": []
  }
}
ETag: 3e6872bc-c9d0-45b6-91b6-da66f1773056
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59",
  "name": "sj59",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 5,
    "eventsLateArrivalMaxDelayInSeconds": 16,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:04.697Z",
    "compatibilityLevel": "1.0",
    "inputs": [],
    "functions": [],
    "outputs": []
  }
}

定義

名前 説明
AggregateFunctionProperties

集計関数に関連付けられているプロパティ。

AuthenticationMode

認証モード。 有効なモードは、 ConnectionStringMsi および 'UserToken' です。

AvroSerialization

入力からのデータをシリアル化する方法、または Avro 形式で出力に書き込むときにデータをシリアル化する方法について説明します。

AzureDataLakeStoreOutputDataSource

Azure Data Lake Store の出力データ ソースについて説明します。

AzureFunctionOutputDataSource

AzureFunctionOutputDataSource のメタデータを定義します

AzureMachineLearningWebServiceFunctionBinding

Azure Machine Learning Web サービスへのバインド。

AzureMachineLearningWebServiceInputColumn

Azure Machine Learning Web サービス エンドポイントの入力列について説明します。

AzureMachineLearningWebServiceInputs

Azure Machine Learning Web サービス エンドポイントの入力。

AzureMachineLearningWebServiceOutputColumn

Azure Machine Learning Web サービス エンドポイントの出力列について説明します。

AzureSqlDatabaseOutputDataSource

Azure SQL データベース出力データ ソースについて説明します。

AzureSqlReferenceInputDataSource

Azure SQL データベース参照入力データ ソースについて説明します。

AzureSynapseOutputDataSource

Azure Synapse出力データ ソースについて説明します。

AzureTableOutputDataSource

Azure Table 出力データ ソースについて説明します。

BlobOutputDataSource

BLOB 出力データ ソースについて説明します。

BlobReferenceInputDataSource

参照データを含む BLOB 入力データ ソースについて説明します。

BlobStreamInputDataSource

ストリーム データを含む BLOB 入力データ ソースについて説明します。

ClusterInfo

Stream Analytics クラスターに関連付けられているプロパティ。

CompatibilityLevel

ストリーミング ジョブの特定のランタイム動作を制御します。

Compression

入力データの圧縮方法について説明します

CompressionType

入力で使用される圧縮の種類を示します。 PUT (CreateOrReplace) 要求で必須。

ContentStoragePolicy

有効な値は JobStorageAccount と SystemAccount です。 JobStorageAccount に設定すると、ユーザーは jobStorageAccount プロパティも指定する必要があります。 .

CsvSerialization

入力からのデータをシリアル化する方法、または CSV 形式で出力に書き込むときにデータをシリアル化する方法について説明します。

DiagnosticCondition

顧客の注意を必要とするリソースまたはジョブ全体に適用される条件。

Diagnostics

入力、出力、またはジョブ全体に適用される、顧客の注意を必要とする条件について説明します。

DocumentDbOutputDataSource

DocumentDB 出力データ ソースについて説明します。

Encoding

入力の場合は受信データのエンコード、出力の場合は送信データのエンコードを指定します。

Error

一般的なエラー表現。

EventHubOutputDataSource

Event Hub の出力データ ソースについて説明します。

EventHubStreamInputDataSource

ストリーム データを含む Event Hub 入力データ ソースについて説明します。

EventHubV2OutputDataSource

Event Hub の出力データ ソースについて説明します。

EventHubV2StreamInputDataSource

ストリーム データを含む Event Hub 入力データ ソースについて説明します。

EventSerializationType

入力または出力で使用されるシリアル化の種類を示します。 PUT (CreateOrReplace) 要求で必須。

EventsOutOfOrderPolicy

入力イベント ストリームで正しくない順序で到達したイベントに適用するポリシーを示します。

FileReferenceInputDataSource

参照データを含むファイル入力データ ソースについて説明します。

Function

名前付き関数に関連付けられているすべての情報を含む関数オブジェクト。 すべての関数はストリーミング ジョブの下に含まれます。

FunctionInput

関数の 1 つの入力パラメーターについて説明します。

FunctionOutput

関数の出力について説明します。

GatewayMessageBusOutputDataSource

ゲートウェイ メッセージ バス出力データ ソースについて説明します。

GatewayMessageBusStreamInputDataSource

ストリーム データを含む BLOB 入力データ ソースについて説明します。

Identity

ID の検証方法について説明します

Input

名前付き入力に関連付けられているすべての情報を格納する入力オブジェクト。 すべての入力はストリーミング ジョブの下に含まれます。

IoTHubStreamInputDataSource

ストリーム データを含むIoT Hub入力データ ソースについて説明します。

JavaScriptFunctionBinding

JavaScript 関数へのバインド。

JobStorageAccount

MSI を使用する Azure Storage アカウントに関連付けられているプロパティ

JobType

ジョブの種類について説明します。 有効なモードは Cloud と 'Edge' です。

JsonOutputSerializationFormat

出力が書き込まれる JSON の形式を指定します。 現在サポートされている値は、出力が新しい行で区切られた各 JSON オブジェクトと、出力が JSON オブジェクトの配列として書式設定されることを示す 'array' で書式設定されることを示す 'lineSeparated' です。

JsonSerialization

入力からのデータをシリアル化する方法、または JSON 形式で出力に書き込むときにデータをシリアル化する方法について説明します。

Output

名前付き出力に関連付けられているすべての情報を含む出力オブジェクト。 すべての出力はストリーミング ジョブの下に含まれます。

OutputErrorPolicy

出力に到達したが、形式が正しくないため (列値が欠けている、列値の種類やサイズが間違っている)、外部ストレージに書き込めないイベントに適用するポリシーを示します。

OutputStartMode

ジョブが開始されるたびに出力イベント ストリームの開始点を開始するか、outputStartTime プロパティを使用して指定されたカスタム ユーザー タイム スタンプから開始するか、最後のイベント出力時刻から開始するかを示すには、JobStartTime、CustomTime、または LastOutputEventTime を指定できます。

ParquetSerialization

入力からのデータをシリアル化する方法、または Parquet 形式で出力に書き込むときにデータをシリアル化する方法について説明します。

PowerBIOutputDataSource

Power BI 出力データ ソースについて説明します。

ReferenceInputProperties

参照データを含む入力に関連付けられているプロパティ。

RefreshType

データ更新オプションの種類を示します。

ScalarFunctionProperties

スカラー関数に関連付けられているプロパティ。

ServiceBusQueueOutputDataSource

Service Bus キューの出力データ ソースについて説明します。

ServiceBusTopicOutputDataSource

Service Bus トピックの出力データ ソースについて説明します。

Sku

SKU に関連付けられているプロパティ。

SkuName

SKU の名前。 PUT (CreateOrReplace) 要求で必須。

StorageAccount

Azure Storage アカウントに関連付けられているプロパティ

StreamingJob

名前付きストリーミング ジョブに関連付けられているすべての情報を含むストリーミング ジョブ オブジェクト。

StreamInputProperties

ストリーム データを含む入力に関連付けられているプロパティ。

Transformation

名前付き変換に関連付けられているすべての情報を含む変換オブジェクト。 すべての変換はストリーミング ジョブの下に含まれます。

AggregateFunctionProperties

集計関数に関連付けられているプロパティ。

名前 説明
etag

string

関数の現在のエンティティ タグ。 これは不透明な文字列です。 これを使用して、要求間でリソースが変更されたかどうかを検出できます。 また、オプティミスティック コンカレンシーの書き込み操作に対して、If-Match ヘッダーまたは If-None-Match ヘッダーで使用することもできます。

properties.binding FunctionBinding:

関数の物理バインディング。 たとえば、Azure Machine Learning Web サービスの場合、エンドポイントについて説明します。

properties.inputs

FunctionInput[]

関数の 1 つの入力パラメーターについて説明します。

properties.output

FunctionOutput

関数の出力について説明します。

type string:

Aggregate

関数の種類を示します。

AuthenticationMode

認証モード。 有効なモードは、 ConnectionStringMsi および 'UserToken' です。

名前 説明
ConnectionString

string

Msi

string

UserToken

string

AvroSerialization

入力からのデータをシリアル化する方法、または Avro 形式で出力に書き込むときにデータをシリアル化する方法について説明します。

名前 説明
type string:

Avro

入力または出力で使用されるシリアル化の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

AzureDataLakeStoreOutputDataSource

Azure Data Lake Store の出力データ ソースについて説明します。

名前 規定値 説明
properties.accountName

string

Azure Data Lake Store アカウントの名前。 PUT (CreateOrReplace) 要求で必要です。

properties.authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.dateFormat

string

日付の形式。 {date} が filePathPrefix 内のどこに表示される場合でも、代わりにこのプロパティの値が日付形式として使用されます。

properties.filePathPrefix

string

出力の書き込み先となるファイルの場所。 PUT (CreateOrReplace) 要求で必要です。

properties.refreshToken

string

データ ソースで認証するために使用できる有効なアクセス トークンを取得するために使用できる更新トークン。 現在、有効な更新トークンは Azure Portal 経由でのみ取得できます。 データ ソースを作成し、Azure Portal に移動してデータ ソースを認証するときに、有効な更新トークンでこのプロパティを更新するダミー文字列値をここに配置することをお勧めします。 PUT (CreateOrReplace) 要求で必要です。

properties.tenantId

string

更新トークンの取得に使用されるユーザーのテナント ID。 PUT (CreateOrReplace) 要求で必要です。

properties.timeFormat

string

時刻の形式。 {time} が filePathPrefix に表示される場合は、このプロパティの値が代わりに時刻形式として使用されます。

properties.tokenUserDisplayName

string

更新トークンの取得に使用されたユーザーのユーザー表示名。 このプロパティを使用すると、更新トークンを取得するために使用されたユーザーを覚えておくのに役立ちます。

properties.tokenUserPrincipalName

string

更新トークンの取得に使用されたユーザーのユーザー プリンシパル名 (UPN)。 このプロパティを使用すると、更新トークンを取得するために使用されたユーザーを覚えておくのに役立ちます。

type string:

Microsoft.DataLake/Accounts

書き込まれるデータ ソース出力の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

AzureFunctionOutputDataSource

AzureFunctionOutputDataSource のメタデータを定義します

名前 説明
properties.apiKey

string

別のサブスクリプションの Azure Functions を使用するには、ご自分の関数にアクセスするためのキーを指定します。

properties.functionAppName

string

Azure Functions アプリの名前です。

properties.functionName

string

ご自分の Azure Functions アプリ内にある関数の名前です。

properties.maxBatchCount

number

Azure Functions に送信される各バッチのイベントの最大数を指定できるプロパティです。 既定値は 100 です。

properties.maxBatchSize

number

ご自分の Azure Functions に送信される各出力バッチの最大サイズを設定できるプロパティです。 入力の単位はバイトです。 既定値は 262,144 バイト (256 KB) です。

type string:

Microsoft.AzureFunction

書き込まれるデータ ソース出力の種類を示します。 PUT (CreateOrReplace) 要求で必須。

AzureMachineLearningWebServiceFunctionBinding

Azure Machine Learning Web サービスへのバインド。

名前 説明
properties.apiKey

string

Request-Response エンドポイントで認証するために使用される API キー。

properties.batchSize

integer

Azure ML RRS の実行要求ごとの最大行数を示す 1 から 10000 までの数。 既定値は 1000 です。

properties.endpoint

string

Request-Response Azure Machine Learning Web サービスのエンドポイントを実行します。 詳細については、こちらを参照してください。 https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs

properties.inputs

AzureMachineLearningWebServiceInputs

Azure Machine Learning Web サービス エンドポイントの入力。

properties.outputs

AzureMachineLearningWebServiceOutputColumn[]

Azure Machine Learning Web サービス エンドポイントの実行からの出力の一覧。

type string:

Microsoft.MachineLearning/WebService

関数バインドの種類を示します。

AzureMachineLearningWebServiceInputColumn

Azure Machine Learning Web サービス エンドポイントの入力列について説明します。

名前 説明
dataType

string

入力列の (Azure Machine Learning でサポートされている) データ型。 有効な Azure Machine Learning データ型の一覧については、 を参照してください https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx

mapTo

integer

この入力がマップされる関数パラメーターの 0 から始まるインデックス。

name

string

入力列の名前。

AzureMachineLearningWebServiceInputs

Azure Machine Learning Web サービス エンドポイントの入力。

名前 説明
columnNames

AzureMachineLearningWebServiceInputColumn[]

Azure Machine Learning Web サービス エンドポイントの入力列の一覧。

name

string

入力の名前。 これは、エンドポイントの作成中に指定された名前です。

AzureMachineLearningWebServiceOutputColumn

Azure Machine Learning Web サービス エンドポイントの出力列について説明します。

名前 説明
dataType

string

出力列の (Azure Machine Learning でサポートされている) データ型。 有効な Azure Machine Learning データ型の一覧については、 を参照してください https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx

name

string

出力列の名前。

AzureSqlDatabaseOutputDataSource

Azure SQL データベース出力データ ソースについて説明します。

名前 規定値 説明
properties.authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.database

string

Azure SQL データベースの名前。 PUT (CreateOrReplace) 要求で必須。

properties.maxBatchCount

number

Sql データベースへの書き込みの最大バッチ数。既定値は 10,000 です。 PUT 要求では省略可能です。

properties.maxWriterCount

number

最大ライター数(現在は 1 (単一ライター) と 0 (クエリ パーティションに基づく) のみが使用できます。 PUT 要求では省略可能です。

properties.password

string

Azure SQL データベースへの接続に使用するパスワード。 PUT (CreateOrReplace) 要求で必須。

properties.server

string

Azure SQL データベースを含む SQL サーバーの名前。 PUT (CreateOrReplace) 要求で必須。

properties.table

string

Azure SQL データベース内のテーブルの名前。 PUT (CreateOrReplace) 要求で必須。

properties.user

string

Azure SQL データベースへの接続に使用されるユーザー名。 PUT (CreateOrReplace) 要求で必須。

type string:

Microsoft.Sql/Server/Database

書き込まれるデータ ソース出力の種類を示します。 PUT (CreateOrReplace) 要求で必須。

AzureSqlReferenceInputDataSource

Azure SQL データベース参照入力データ ソースについて説明します。

名前 説明
properties.database

string

この要素は [データソース] 要素に関連付けられています。 これは出力が書き込まれるデータベースの名前です。

properties.deltaSnapshotQuery

string

この要素は [データソース] 要素に関連付けられています。 このクエリは、SQL データベースから増分変更をフェッチするために使用されます。 このオプションを使用するには、Azure SQL Database でテンポラル テーブルを使用することをお勧めします。

properties.fullSnapshotQuery

string

この要素は [データソース] 要素に関連付けられています。 このクエリは、SQL データベースからデータをフェッチするために使用されます。

properties.password

string

この要素は [データソース] 要素に関連付けられています。 これは SQL データベース インスタンスに接続するために使用されるパスワードです。

properties.refreshRate

string

この要素は [データソース] 要素に関連付けられています。 これは、データベースからデータをフェッチする頻度を示します。 DateTime 形式です。

properties.refreshType

RefreshType

データ更新オプションの種類を示します。

properties.server

string

この要素は [データソース] 要素に関連付けられています。 これは書き込み先のデータベース含むサーバーの名前です。

properties.table

string

この要素は [データソース] 要素に関連付けられています。 Azure SQL データベース内のテーブルの名前。

properties.user

string

この要素は [データソース] 要素に関連付けられています。 これは SQL データベース インスタンスに接続するために使用されるユーザー名です。

type string:

Microsoft.Sql/Server/Database

参照データを含む入力データ ソースの種類を示します。 PUT (CreateOrReplace) 要求で必要です。

AzureSynapseOutputDataSource

Azure Synapse出力データ ソースについて説明します。

名前 説明
properties.database

string

Azure SQL データベースの名前。 PUT (CreateOrReplace) 要求で必須。

properties.password

string

Azure SQL データベースへの接続に使用するパスワード。 PUT (CreateOrReplace) 要求で必須。

properties.server

string

Azure SQL データベースを含む SQL サーバーの名前。 PUT (CreateOrReplace) 要求で必須。

properties.table

string

Azure SQL データベース内のテーブルの名前。 PUT (CreateOrReplace) 要求で必須。

properties.user

string

Azure SQL データベースへの接続に使用されるユーザー名。 PUT (CreateOrReplace) 要求で必須。

type string:

Microsoft.Sql/Server/DataWarehouse

書き込まれるデータ ソース出力の種類を示します。 PUT (CreateOrReplace) 要求で必須。

AzureTableOutputDataSource

Azure Table 出力データ ソースについて説明します。

名前 説明
properties.accountKey

string

Azure Storage アカウントのアカウント キー。 PUT (CreateOrReplace) 要求で必須。

properties.accountName

string

Azure ストレージ アカウントの名前。 PUT (CreateOrReplace) 要求で必須。

properties.batchSize

integer

一度に Azure Table に書き込む行数。

properties.columnsToRemove

string[]

指定されている場合、配列の各項目は出力イベント エンティティから (存在する場合) 削除される列の名前になります。

properties.partitionKey

string

この要素は、Azure Table のパーティション キーとして使用されるクエリの SELECT ステートメントの列の名前を示します。 PUT (CreateOrReplace) 要求で必須。

properties.rowKey

string

この要素は、Azure Table の行キーとして使用されるクエリの SELECT ステートメントの列の名前を示します。 PUT (CreateOrReplace) 要求で必須。

properties.table

string

Azure テーブルの名前。 PUT (CreateOrReplace) 要求で必須。

type string:

Microsoft.Storage/Table

書き込まれるデータ ソース出力の種類を示します。 PUT (CreateOrReplace) 要求で必須。

BlobOutputDataSource

BLOB 出力データ ソースについて説明します。

名前 規定値 説明
properties.authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.blobPathPrefix

string

BLOB パス プレフィックス。

properties.container

string

関連付けられているストレージ アカウント内のコンテナーの名前。 このコンテナーには、読み取り元または書き込み元の BLOB のいずれかが含まれます。 PUT (CreateOrReplace) 要求で必須。

properties.dateFormat

string

日付の形式。 pathPattern に {date} が表示される場所では、代わりにこのプロパティの値が日付形式として使用されます。

properties.pathPattern

string

BLOB パス パターン。 正規表現ではありません。 これは、BLOB 名がジョブへの入力または出力として含める必要があるかどうかを判断するために照合されるパターンを表します。 詳細な説明と例については https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 、 または https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output を参照してください。

properties.storageAccounts

StorageAccount[]

1 つ以上の Azure Storage アカウントの一覧。 PUT (CreateOrReplace) 要求で必須。

properties.timeFormat

string

時刻の形式。 {time} が pathPattern に表示される場合は、このプロパティの値が代わりに時刻形式として使用されます。

type string:

Microsoft.Storage/Blob

書き込まれるデータ ソース出力の種類を示します。 PUT (CreateOrReplace) 要求で必須。

BlobReferenceInputDataSource

参照データを含む BLOB 入力データ ソースについて説明します。

名前 規定値 説明
properties.authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.container

string

関連付けられているストレージ アカウント内のコンテナーの名前。 このコンテナーには、読み取り元または書き込み元の BLOB のいずれかが含まれます。 PUT (CreateOrReplace) 要求で必須。

properties.dateFormat

string

日付の形式。 {date} が pathPattern に表示される場合は、このプロパティの値が代わりに日付形式として使用されます。

properties.pathPattern

string

BLOB パス パターン。 正規表現ではありません。 これは、BLOB 名がジョブへの入力または出力として含める必要があるかどうかを判断するために照合されるパターンを表します。 詳細な説明と例については https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 、 または https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output を参照してください。

properties.storageAccounts

StorageAccount[]

1 つ以上の Azure Storage アカウントの一覧。 PUT (CreateOrReplace) 要求で必須。

properties.timeFormat

string

時刻の形式。 {time} が pathPattern に表示される場合は、このプロパティの値が代わりに時刻形式として使用されます。

type string:

Microsoft.Storage/Blob

参照データを含む入力データ ソースの種類を示します。 PUT (CreateOrReplace) 要求で必須。

BlobStreamInputDataSource

ストリーム データを含む BLOB 入力データ ソースについて説明します。

名前 規定値 説明
properties.authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.container

string

関連付けられているストレージ アカウント内のコンテナーの名前。 このコンテナーには、読み取り元または書き込み元の BLOB のいずれかが含まれます。 PUT (CreateOrReplace) 要求で必須。

properties.dateFormat

string

日付の形式。 pathPattern に {date} が表示される場所では、代わりにこのプロパティの値が日付形式として使用されます。

properties.pathPattern

string

BLOB パス パターン。 正規表現ではありません。 これは、BLOB 名がジョブへの入力または出力として含める必要があるかどうかを判断するために照合されるパターンを表します。 詳細な説明と例については https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 、 または https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output を参照してください。

properties.sourcePartitionCount

integer

BLOB 入力データ ソースのパーティション数。 範囲 1 ~ 1024。

properties.storageAccounts

StorageAccount[]

1 つ以上の Azure Storage アカウントの一覧。 PUT (CreateOrReplace) 要求で必須。

properties.timeFormat

string

時刻の形式。 {time} が pathPattern に表示される場合は、このプロパティの値が代わりに時刻形式として使用されます。

type string:

Microsoft.Storage/Blob

ストリーム データを含む入力データ ソースの種類を示します。 PUT (CreateOrReplace) 要求で必須。

ClusterInfo

Stream Analytics クラスターに関連付けられているプロパティ。

名前 説明
id

string

クラスターのリソース ID。

CompatibilityLevel

ストリーミング ジョブの特定のランタイム動作を制御します。

名前 説明
1.0

string

1.2

string

Compression

入力データの圧縮方法について説明します

名前 規定値 説明
type

CompressionType

None

入力で使用される圧縮の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

CompressionType

入力で使用される圧縮の種類を示します。 PUT (CreateOrReplace) 要求で必須。

名前 説明
Deflate

string

GZip

string

None

string

ContentStoragePolicy

有効な値は JobStorageAccount と SystemAccount です。 JobStorageAccount に設定すると、ユーザーは jobStorageAccount プロパティも指定する必要があります。 .

名前 説明
JobStorageAccount

string

SystemAccount

string

CsvSerialization

入力からのデータをシリアル化する方法、または CSV 形式で出力に書き込むときにデータをシリアル化する方法について説明します。

名前 説明
properties.encoding

Encoding

入力の場合の受信データのエンコードと、出力の場合の送信データのエンコードを指定します。 PUT (CreateOrReplace) 要求で必要です。

properties.fieldDelimiter

string

コンマ区切り値 (CSV) レコードを区切るために使用する区切り記号を指定します。 サポートされている値の一覧については、 または https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output を参照してくださいhttps://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input。 PUT (CreateOrReplace) 要求で必要です。

type string:

Csv

入力または出力で使用されるシリアル化の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

DiagnosticCondition

顧客の注意を必要とするリソースまたはジョブ全体に適用される条件。

名前 説明
code

string

不透明な診断コード。

message

string

条件を詳しく説明する人間が判読できるメッセージ。 クライアント要求の Accept-Language にローカライズされます。

since

string

条件が開始されたときの UTC タイムスタンプ。 この時点で、お客様は ops ログで対応するイベントを見つけることができます。

Diagnostics

入力、出力、またはジョブ全体に適用される、顧客の注意を必要とする条件について説明します。

名前 説明
conditions

DiagnosticCondition[]

リソースまたはジョブ全体に適用できる、顧客の注意を必要とする 0 個以上の条件のコレクション。

DocumentDbOutputDataSource

DocumentDB 出力データ ソースについて説明します。

名前 説明
properties.accountId

string

DocumentDB アカウント名または ID。 PUT (CreateOrReplace) 要求で必須。

properties.accountKey

string

DocumentDB アカウントのアカウント キー。 PUT (CreateOrReplace) 要求で必須。

properties.collectionNamePattern

string

使用するコレクションのコレクション名のパターン。 コレクション名の形式は、オプションの {partition} トークンを使用して構成できます。この場合、パーティションは 0 から開始します。 詳細については、 の DocumentDB セクション https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output を参照してください。 PUT (CreateOrReplace) 要求で必須。

properties.database

string

DocumentDB データベースの名前。 PUT (CreateOrReplace) 要求で必須。

properties.documentId

string

挿入または更新操作の基準となるプライマリ キーを指定するために使用される、出力イベント内のフィールドの名前。

properties.partitionKey

string

コレクション全体で出力をパーティション分割するためのキーを指定するために使用される、出力イベント内のフィールドの名前。 'collectionNamePattern' に {partition} トークンが含まれている場合は、このプロパティを指定する必要があります。

type string:

Microsoft.Storage/DocumentDB

書き込まれるデータ ソース出力の種類を示します。 PUT (CreateOrReplace) 要求で必須。

Encoding

入力の場合は受信データのエンコード、出力の場合は送信データのエンコードを指定します。

名前 説明
UTF8

string

Error

一般的なエラー表現。

名前 説明
error

Error

エラー定義のプロパティ。

EventHubOutputDataSource

Event Hub の出力データ ソースについて説明します。

名前 規定値 説明
authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.eventHubName

string

イベント ハブの名前。 PUT (CreateOrReplace) 要求で必須。

properties.partitionKey

string

イベント データを送信するパーティションを決定するために使用されるキー/列。

properties.propertyColumns

string[]

このイベント ハブ出力に関連付けられているプロパティ。

serviceBusNamespace

string

目的のイベント ハブ、Service Bus キュー、Service Bus トピックなどに関連付けられている名前空間。PUT (CreateOrReplace) 要求で必須。

sharedAccessPolicyKey

string

指定した共有アクセス ポリシーの共有アクセス ポリシー キー。 PUT (CreateOrReplace) 要求で必須。

sharedAccessPolicyName

string

イベント ハブ、Service Bus キュー、Service Bus トピックなどの共有アクセス ポリシー名。PUT (CreateOrReplace) 要求で必須。

type string:

Microsoft.ServiceBus/EventHub

書き込まれるデータ ソース出力の種類を示します。 PUT (CreateOrReplace) 要求で必須。

EventHubStreamInputDataSource

ストリーム データを含む Event Hub 入力データ ソースについて説明します。

名前 規定値 説明
authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.consumerGroupName

string

イベント ハブからイベントを読み取るために使用する必要がある Event Hub コンシューマー グループの名前。 複数の入力に個別のコンシューマー グループ名を指定すると、それらの各入力がイベント ハブから同じイベントを受信できます。 指定しない場合、入力では Event Hub の既定のコンシューマー グループが使用されます。

properties.eventHubName

string

イベント ハブの名前。 PUT (CreateOrReplace) 要求で必須。

serviceBusNamespace

string

目的のイベント ハブ、Service Bus キュー、Service Bus トピックなどに関連付けられている名前空間。PUT (CreateOrReplace) 要求で必須。

sharedAccessPolicyKey

string

指定した共有アクセス ポリシーの共有アクセス ポリシー キー。 PUT (CreateOrReplace) 要求で必須。

sharedAccessPolicyName

string

イベント ハブ、Service Bus キュー、Service Bus トピックなどの共有アクセス ポリシー名。PUT (CreateOrReplace) 要求で必須。

type string:

Microsoft.ServiceBus/EventHub

ストリーム データを含む入力データ ソースの種類を示します。 PUT (CreateOrReplace) 要求で必須。

EventHubV2OutputDataSource

Event Hub の出力データ ソースについて説明します。

名前 規定値 説明
authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.eventHubName

string

イベント ハブの名前。 PUT (CreateOrReplace) 要求で必須。

properties.partitionKey

string

イベント データを送信するパーティションを決定するために使用されるキー/列。

properties.propertyColumns

string[]

このイベント ハブ出力に関連付けられているプロパティ。

serviceBusNamespace

string

目的のイベント ハブ、Service Bus キュー、Service Bus トピックなどに関連付けられている名前空間。PUT (CreateOrReplace) 要求で必須。

sharedAccessPolicyKey

string

指定した共有アクセス ポリシーの共有アクセス ポリシー キー。 PUT (CreateOrReplace) 要求で必須。

sharedAccessPolicyName

string

イベント ハブ、Service Bus キュー、Service Bus トピックなどの共有アクセス ポリシー名。PUT (CreateOrReplace) 要求で必須。

type string:

Microsoft.EventHub/EventHub

書き込まれるデータ ソース出力の種類を示します。 PUT (CreateOrReplace) 要求で必須。

EventHubV2StreamInputDataSource

ストリーム データを含む Event Hub 入力データ ソースについて説明します。

名前 規定値 説明
authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.consumerGroupName

string

イベント ハブからイベントを読み取るために使用する必要がある Event Hub コンシューマー グループの名前。 複数の入力に個別のコンシューマー グループ名を指定すると、それらの各入力がイベント ハブから同じイベントを受信できます。 指定しない場合、入力では Event Hub の既定のコンシューマー グループが使用されます。

properties.eventHubName

string

イベント ハブの名前。 PUT (CreateOrReplace) 要求で必須。

serviceBusNamespace

string

目的のイベント ハブ、Service Bus キュー、Service Bus トピックなどに関連付けられている名前空間。PUT (CreateOrReplace) 要求で必須。

sharedAccessPolicyKey

string

指定した共有アクセス ポリシーの共有アクセス ポリシー キー。 PUT (CreateOrReplace) 要求で必須。

sharedAccessPolicyName

string

イベント ハブ、Service Bus キュー、Service Bus トピックなどの共有アクセス ポリシー名。PUT (CreateOrReplace) 要求で必須。

type string:

Microsoft.EventHub/EventHub

ストリーム データを含む入力データ ソースの種類を示します。 PUT (CreateOrReplace) 要求で必須。

EventSerializationType

入力または出力で使用されるシリアル化の種類を示します。 PUT (CreateOrReplace) 要求で必須。

名前 説明
Avro

string

Csv

string

Json

string

Parquet

string

EventsOutOfOrderPolicy

入力イベント ストリームで正しくない順序で到達したイベントに適用するポリシーを示します。

名前 説明
Adjust

string

Drop

string

FileReferenceInputDataSource

参照データを含むファイル入力データ ソースについて説明します。

名前 説明
properties.path

string

ファイルのパス。

type string:

File

参照データを含む入力データ ソースの種類を示します。 PUT (CreateOrReplace) 要求で必須。

Function

名前付き関数に関連付けられているすべての情報を含む関数オブジェクト。 すべての関数はストリーミング ジョブの下に含まれます。

名前 説明
id

string

リソース ID

name

string

リソース名

properties FunctionProperties:

関数に関連付けられているプロパティ。

type

string

リソースの種類

FunctionInput

関数の 1 つの入力パラメーターについて説明します。

名前 説明
dataType

string

関数入力パラメーターの (Azure Stream Analytics でサポートされている) データ型。 有効な Azure Stream Analytics データ型の一覧については、 https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx

isConfigurationParameter

boolean

パラメーターが構成パラメーターであるかどうかを示すフラグ。 True を指定すると、この入力パラメーターは定数になります。 既定値は false です。

FunctionOutput

関数の出力について説明します。

名前 説明
dataType

string

関数出力の (Azure Stream Analytics でサポートされている) データ型。 有効な Azure Stream Analytics データ型の一覧については、 https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx

GatewayMessageBusOutputDataSource

ゲートウェイ メッセージ バス出力データ ソースについて説明します。

名前 説明
properties.topic

string

Service Bus トピックの名前。

type string:

GatewayMessageBus

書き込まれるデータ ソース出力の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

GatewayMessageBusStreamInputDataSource

ストリーム データを含む BLOB 入力データ ソースについて説明します。

名前 説明
properties.topic

string

Service Bus トピックの名前。

type string:

GatewayMessageBus

ストリーム データを含む入力データ ソースの種類を示します。 PUT (CreateOrReplace) 要求で必須。

Identity

ID の検証方法について説明します

名前 説明
principalId

string

ID プリンシパル ID

tenantId

string

ID tenantId

type

string

ID の種類

Input

名前付き入力に関連付けられているすべての情報を格納する入力オブジェクト。 すべての入力はストリーミング ジョブの下に含まれます。

名前 説明
id

string

リソース ID

name

string

リソース名

properties InputProperties:

入力に関連付けられているプロパティ。 PUT (CreateOrReplace) 要求で必須。

type

string

リソースの種類

IoTHubStreamInputDataSource

ストリーム データを含むIoT Hub入力データ ソースについて説明します。

名前 説明
properties.consumerGroupName

string

IoT Hubからイベントを読み取るために使用する必要があるIoT Hub コンシューマー グループの名前。 指定しない場合、入力では Iot Hub の既定のコンシューマー グループが使用されます。

properties.endpoint

string

接続するIoT Hubエンドポイント (つまり、messages/events、messages/operationsMonitoringEvents など)。

properties.iotHubNamespace

string

IoT Hubの名前または URI。 PUT (CreateOrReplace) 要求で必須。

properties.sharedAccessPolicyKey

string

指定した共有アクセス ポリシーの共有アクセス ポリシー キー。 PUT (CreateOrReplace) 要求で必須。

properties.sharedAccessPolicyName

string

IoT Hubの共有アクセス ポリシー名。 このポリシーには、少なくともサービス接続アクセス許可が含まれている必要があります。 PUT (CreateOrReplace) 要求で必須。

type string:

Microsoft.Devices/IotHubs

ストリーム データを含む入力データ ソースの種類を示します。 PUT (CreateOrReplace) 要求で必須。

JavaScriptFunctionBinding

JavaScript 関数へのバインド。

名前 説明
properties.script

string

1 つの関数定義を含む JavaScript コード。 例: 'function (x, y) { return x + y; }'

type string:

Microsoft.StreamAnalytics/JavascriptUdf

関数バインドの種類を示します。

JobStorageAccount

MSI を使用する Azure Storage アカウントに関連付けられているプロパティ

名前 規定値 説明
accountKey

string

Azure Storage アカウントのアカウント キー。 PUT (CreateOrReplace) 要求で必須。

accountName

string

Azure ストレージ アカウントの名前。 PUT (CreateOrReplace) 要求で必須。

authenticationMode

AuthenticationMode

ConnectionString

認証モード。

JobType

ジョブの種類について説明します。 有効なモードは Cloud と 'Edge' です。

名前 説明
Cloud

string

Edge

string

JsonOutputSerializationFormat

出力が書き込まれる JSON の形式を指定します。 現在サポートされている値は、出力が新しい行で区切られた各 JSON オブジェクトと、出力が JSON オブジェクトの配列として書式設定されることを示す 'array' で書式設定されることを示す 'lineSeparated' です。

名前 説明
Array

string

LineSeparated

string

JsonSerialization

入力からのデータをシリアル化する方法、または JSON 形式で出力に書き込むときにデータをシリアル化する方法について説明します。

名前 説明
properties.encoding

Encoding

入力の場合の受信データのエンコードと、出力の場合の送信データのエンコードを指定します。 PUT (CreateOrReplace) 要求で必要です。

properties.format

JsonOutputSerializationFormat

このプロパティは、出力の JSON シリアル化にのみ適用されます。 入力には適用されません。 このプロパティは、出力が書き込まれる JSON の形式を指定します。 現在サポートされている値は、出力が新しい行で区切られた各 JSON オブジェクトを使用して書式設定されることを示す 'lineSeparated' と、出力が JSON オブジェクトの配列として書式設定されることを示す 'array' です。 左 null の場合、既定値は 'lineSeparated' です。

type string:

Json

入力または出力で使用されるシリアル化の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

Output

名前付き出力に関連付けられているすべての情報を含む出力オブジェクト。 すべての出力はストリーミング ジョブの下に含まれます。

名前 説明
id

string

リソース ID

name

string

リソース名

properties.datasource OutputDataSource:

出力の書き込み先となるデータ ソースについて説明します。 PUT (CreateOrReplace) 要求で必須。

properties.diagnostics

Diagnostics

入力、出力、またはジョブ全体に適用される、顧客の注意を必要とする条件について説明します。

properties.etag

string

出力の現在のエンティティ タグ。 これは不透明な文字列です。 これを使用して、要求間でリソースが変更されたかどうかを検出できます。 また、オプティミスティック コンカレンシーの書き込み操作に対して、If-Match ヘッダーまたは If-None-Match ヘッダーで使用することもできます。

properties.serialization Serialization:

入力のデータをシリアル化する方法、または出力に書き込むときにデータをシリアル化する方法について説明します。 PUT (CreateOrReplace) 要求で必須。

properties.sizeWindow

integer

Stream Analytics の出力を制限するサイズ ウィンドウ。

properties.timeWindow

string

Stream Analytics ジョブの出力をフィルター処理するための期間。

type

string

リソースの種類

OutputErrorPolicy

出力に到達したが、形式が正しくないため (列値が欠けている、列値の種類やサイズが間違っている)、外部ストレージに書き込めないイベントに適用するポリシーを示します。

名前 説明
Drop

string

Stop

string

OutputStartMode

ジョブが開始されるたびに出力イベント ストリームの開始点を開始するか、outputStartTime プロパティを使用して指定されたカスタム ユーザー タイム スタンプから開始するか、最後のイベント出力時刻から開始するかを示すには、JobStartTime、CustomTime、または LastOutputEventTime を指定できます。

名前 説明
CustomTime

string

JobStartTime

string

LastOutputEventTime

string

ParquetSerialization

入力からのデータをシリアル化する方法、または Parquet 形式で出力に書き込むときにデータをシリアル化する方法について説明します。

名前 説明
type string:

Parquet

入力または出力で使用されるシリアル化の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

PowerBIOutputDataSource

Power BI 出力データ ソースについて説明します。

名前 規定値 説明
properties.authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.dataset

string

Power BI データセットの名前。 PUT (CreateOrReplace) 要求で必要です。

properties.groupId

string

Power BI グループの ID。

properties.groupName

string

Power BI グループの名前。 このプロパティを使用すると、使用された特定の Power BI グループ ID を覚えておくのに役立ちます。

properties.refreshToken

string

データ ソースで認証するために使用できる有効なアクセス トークンを取得するために使用できる更新トークン。 現在、有効な更新トークンは Azure Portal 経由でのみ取得できます。 データ ソースを作成し、Azure Portal に移動してデータ ソースを認証するときに、有効な更新トークンでこのプロパティを更新するダミー文字列値をここに配置することをお勧めします。 PUT (CreateOrReplace) 要求で必要です。

properties.table

string

指定したデータセットの下にある Power BI テーブルの名前。 PUT (CreateOrReplace) 要求で必要です。

properties.tokenUserDisplayName

string

更新トークンの取得に使用されたユーザーのユーザー表示名。 このプロパティを使用すると、更新トークンを取得するために使用されたユーザーを覚えておくのに役立ちます。

properties.tokenUserPrincipalName

string

更新トークンの取得に使用されたユーザーのユーザー プリンシパル名 (UPN)。 このプロパティを使用すると、更新トークンを取得するために使用されたユーザーを覚えておくのに役立ちます。

type string:

PowerBI

書き込まれるデータ ソース出力の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

ReferenceInputProperties

参照データを含む入力に関連付けられているプロパティ。

名前 説明
compression

Compression

入力データの圧縮方法について説明します

datasource ReferenceInputDataSource:

参照データを含む入力データ ソースについて説明します。 PUT (CreateOrReplace) 要求で必須。

diagnostics

Diagnostics

入力、出力、またはジョブ全体に適用される、顧客の注意を必要とする条件について説明します。

etag

string

入力の現在のエンティティ タグ。 これは不透明な文字列です。 これを使用して、要求間でリソースが変更されたかどうかを検出できます。 また、オプティミスティック コンカレンシーの書き込み操作に対して、If-Match ヘッダーまたは If-None-Match ヘッダーで使用することもできます。

partitionKey

string

partitionKey 入力データのパーティション分割に使用される入力データ内のキーについて説明します

serialization Serialization:

入力のデータをシリアル化する方法、または出力に書き込むときにデータをシリアル化する方法について説明します。 PUT (CreateOrReplace) 要求で必須。

type string:

Reference

入力が参照データのソースかストリーム データかを示します。 PUT (CreateOrReplace) 要求で必須。

RefreshType

データ更新オプションの種類を示します。

名前 説明
RefreshPeriodicallyWithDelta

string

RefreshPeriodicallyWithFull

string

Static

string

ScalarFunctionProperties

スカラー関数に関連付けられているプロパティ。

名前 説明
etag

string

関数の現在のエンティティ タグ。 これは不透明な文字列です。 これを使用して、要求間でリソースが変更されたかどうかを検出できます。 また、オプティミスティック コンカレンシーの書き込み操作に対して、If-Match ヘッダーまたは If-None-Match ヘッダーで使用することもできます。

properties.binding FunctionBinding:

関数の物理バインディング。 たとえば、Azure Machine Learning Web サービスの場合、エンドポイントについて説明します。

properties.inputs

FunctionInput[]

関数の 1 つの入力パラメーターについて説明します。

properties.output

FunctionOutput

関数の出力について説明します。

type string:

Scalar

関数の種類を示します。

ServiceBusQueueOutputDataSource

Service Bus キューの出力データ ソースについて説明します。

名前 規定値 説明
properties.authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.propertyColumns

string[]

Service Bus メッセージにカスタム プロパティとして添付する出力列の名前の文字列配列。

properties.queueName

string

Service Bus キューの名前。 PUT (CreateOrReplace) 要求で必須。

properties.serviceBusNamespace

string

目的のイベント ハブ、Service Bus キュー、Service Bus トピックなどに関連付けられている名前空間。PUT (CreateOrReplace) 要求で必須。

properties.sharedAccessPolicyKey

string

指定した共有アクセス ポリシーの共有アクセス ポリシー キー。 PUT (CreateOrReplace) 要求で必須。

properties.sharedAccessPolicyName

string

イベント ハブ、Service Bus キュー、Service Bus トピックなどの共有アクセス ポリシー名。PUT (CreateOrReplace) 要求で必須。

properties.systemPropertyColumns

object

Service Bus キューに関連付けられているシステム プロパティ。 次のシステム プロパティがサポートされています: ReplyToSessionId、ContentType、To、Subject、CorrelationId、TimeToLive、PartitionKey、SessionId、ScheduledEnqueueTime、MessageId、ReplyTo、Label、ScheduledEnqueueTimeUtc。

type string:

Microsoft.ServiceBus/Queue

書き込まれるデータ ソース出力の種類を示します。 PUT (CreateOrReplace) 要求で必須。

ServiceBusTopicOutputDataSource

Service Bus トピックの出力データ ソースについて説明します。

名前 規定値 説明
properties.authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.propertyColumns

string[]

Service Bus メッセージにカスタム プロパティとして添付する出力列の名前の文字列配列。

properties.serviceBusNamespace

string

目的のイベント ハブ、Service Bus キュー、Service Bus トピックなどに関連付けられている名前空間。PUT (CreateOrReplace) 要求で必須。

properties.sharedAccessPolicyKey

string

指定した共有アクセス ポリシーの共有アクセス ポリシー キー。 PUT (CreateOrReplace) 要求で必要です。

properties.sharedAccessPolicyName

string

イベント ハブ、Service Bus キュー、Service Bus トピックなどの共有アクセス ポリシー名。PUT (CreateOrReplace) 要求で必須。

properties.systemPropertyColumns

object

Service Bus トピック出力に関連付けられているシステム プロパティ。 次のシステム プロパティがサポートされています: ReplyToSessionId、ContentType、To、Subject、CorrelationId、TimeToLive、PartitionKey、SessionId、ScheduledEnqueueTime、MessageId、ReplyTo、Label、ScheduledEnqueueTimeUtc。

properties.topicName

string

Service Bus トピックの名前。 PUT (CreateOrReplace) 要求で必須。

type string:

Microsoft.ServiceBus/Topic

書き込まれるデータ ソース出力の種類を示します。 PUT (CreateOrReplace) 要求で必須。

Sku

SKU に関連付けられているプロパティ。

名前 説明
name

SkuName

SKU の名前。 PUT (CreateOrReplace) 要求で必須。

SkuName

SKU の名前。 PUT (CreateOrReplace) 要求で必須。

名前 説明
Standard

string

StorageAccount

Azure Storage アカウントに関連付けられているプロパティ

名前 説明
accountKey

string

Azure Storage アカウントのアカウント キー。 PUT (CreateOrReplace) 要求で必須。

accountName

string

Azure ストレージ アカウントの名前。 PUT (CreateOrReplace) 要求で必須。

StreamingJob

名前付きストリーミング ジョブに関連付けられているすべての情報を含むストリーミング ジョブ オブジェクト。

名前 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

入力と出力で認証するために使用できる、このジョブに割り当てられたシステム割り当てマネージド ID について説明します。

location

string

リソースが保存されている地理的な場所

name

string

リソースの名前

properties.cluster

ClusterInfo

ストリーミング ジョブを実行するクラスター。

properties.compatibilityLevel

CompatibilityLevel

ストリーミング ジョブの特定のランタイム動作を制御します。

properties.contentStoragePolicy

ContentStoragePolicy

有効な値は JobStorageAccount と SystemAccount です。 JobStorageAccount に設定すると、ユーザーは jobStorageAccount プロパティも指定する必要があります。 .

properties.createdDate

string

値は、ストリーミング ジョブがいつ作成されたかを示す ISO-8601 形式の UTC タイムスタンプです。

properties.dataLocale

string

Stream Analytics ジョブのデータ ロケール。 値は、セット https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspxからサポートされている .NET Culture の名前である必要があります。 何も指定されていない場合は "en-US" になります。

properties.etag

string

ストリーミング ジョブの現在のエンティティ タグ。 これは不透明な文字列です。 これを使用して、要求間でリソースが変更されたかどうかを検出できます。 また、オプティミスティック コンカレンシーの書き込み操作に対して、If-Match ヘッダーまたは If-None-Match ヘッダーで使用することもできます。

properties.eventsLateArrivalMaxDelayInSeconds

integer

遅れて到達したイベントを含めるための最大許容遅延 (秒)。 サポートされている範囲は -1 から 1814399 (20.23:59:59 日数) までです。-1 は、無期限待機の指定に使用されます。 プロパティがない場合、値 -1 であると解釈されます。

properties.eventsOutOfOrderMaxDelayInSeconds

integer

順序が正しくないイベントの順序を戻すように調整できる最大許容遅延 (秒)。

properties.eventsOutOfOrderPolicy

EventsOutOfOrderPolicy

入力イベント ストリームで正しくない順序で到達したイベントに適用するポリシーを示します。

properties.functions

Function[]

ストリーミング ジョブの 1 つ以上の関数の一覧。 PUT 要求でこのプロパティを指定する場合は、各関数の name プロパティが必要です。 PATCH 操作を使用してこのプロパティを変更することはできません。 個々の変換に使用できる PATCH API を使用する必要があります。

properties.inputs

Input[]

ストリーミング ジョブへの 1 つ以上の入力の一覧。 PUT 要求でこのプロパティを指定する場合は、各入力の name プロパティが必要です。 PATCH 操作を使用してこのプロパティを変更することはできません。 個々の入力に使用できる PATCH API を使用する必要があります。

properties.jobId

string

ストリーミング ジョブを一意に識別する GUID。 この GUID は、ストリーミング ジョブの作成時に生成されます。

properties.jobState

string

ストリーミング ジョブの状態について説明します。

properties.jobStorageAccount

JobStorageAccount

MSI を使用する Azure Storage アカウントに関連付けられているプロパティ

properties.jobType

JobType

ジョブの種類について説明します。 有効なモードは Cloud と 'Edge' です。

properties.lastOutputEventTime

string

値は、ストリーミング ジョブの最後の出力イベント時刻を示す ISO-8601 形式のタイムスタンプか、出力がまだ生成されていないことを示す null です。 複数の出力または複数のストリームの場合は、そのセットの最新の値が表示されます。

properties.outputErrorPolicy

OutputErrorPolicy

出力に到達したが、形式が正しくないため (列値が欠けている、列値の種類やサイズが間違っている)、外部ストレージに書き込めないイベントに適用するポリシーを示します。

properties.outputStartMode

OutputStartMode

このプロパティは、作成時にジョブをすぐに開始する必要がある場合にのみ使用する必要があります。 ジョブが開始されるたびに出力イベント ストリームの開始点を開始するか、outputStartTime プロパティを使用して指定されたカスタム ユーザー タイム スタンプから開始するか、最後のイベント出力時刻から開始するかを示すには、JobStartTime、CustomTime、または LastOutputEventTime を指定できます。

properties.outputStartTime

string

値は、出力イベント ストリームの開始点を示す、ISO-8601 形式のタイムスタンプか、またはストリーム ジョブが開始されるたびに出力イベント ストリームが開始することを示す Null になります。 outputStartMode が CustomTime に設定されている場合、このプロパティには 値が必要です。

properties.outputs

Output[]

ストリーミング ジョブの 1 つ以上の出力の一覧。 PUT 要求でこのプロパティを指定する場合は、各出力の name プロパティが必要です。 PATCH 操作を使用してこのプロパティを変更することはできません。 個々の出力に使用できる PATCH API を使用する必要があります。

properties.provisioningState

string

ストリーミング ジョブのプロビジョニング状態について説明します。

properties.sku

Sku

ストリーミング ジョブの SKU について説明します。 PUT (CreateOrReplace) 要求で必須。

properties.transformation

Transformation

ストリーミング ジョブに使用するクエリとストリーミング ユニットの数を示します。 PUT 要求でこのプロパティを指定する場合は、変換の name プロパティが必要です。 PATCH 操作を使用してこのプロパティを変更することはできません。 個々の変換に使用できる PATCH API を使用する必要があります。

tags

object

リソース タグ。

type

string

リソースの型。 例: Microsoft.Compute/virtualMachines または Microsoft.Storage/storageAccounts。

StreamInputProperties

ストリーム データを含む入力に関連付けられているプロパティ。

名前 説明
compression

Compression

入力データの圧縮方法について説明します

datasource StreamInputDataSource:

ストリーム データを含む入力データ ソースについて説明します。 PUT (CreateOrReplace) 要求で必須。

diagnostics

Diagnostics

入力、出力、またはジョブ全体に適用される、顧客の注意を必要とする条件について説明します。

etag

string

入力の現在のエンティティ タグ。 これは不透明な文字列です。 これを使用して、要求間でリソースが変更されたかどうかを検出できます。 また、オプティミスティック コンカレンシーの書き込み操作に対して、If-Match ヘッダーまたは If-None-Match ヘッダーで使用することもできます。

partitionKey

string

partitionKey 入力データのパーティション分割に使用される入力データ内のキーについて説明します

serialization Serialization:

入力のデータをシリアル化する方法、または出力に書き込むときにデータをシリアル化する方法について説明します。 PUT (CreateOrReplace) 要求で必須。

type string:

Stream

入力が参照データのソースかストリーム データかを示します。 PUT (CreateOrReplace) 要求で必須。

Transformation

名前付き変換に関連付けられているすべての情報を含む変換オブジェクト。 すべての変換はストリーミング ジョブの下に含まれます。

名前 規定値 説明
id

string

リソース ID

name

string

リソース名

properties.etag

string

変換の現在のエンティティ タグ。 これは不透明な文字列です。 これを使用して、要求間でリソースが変更されたかどうかを検出できます。 また、オプティミスティック コンカレンシーの書き込み操作に対して、If-Match ヘッダーまたは If-None-Match ヘッダーで使用することもできます。

properties.query

string

ストリーミング ジョブで実行されるクエリを指定します。 Stream Analytics クエリ言語 (SAQL) の詳細については、 https://msdn.microsoft.com/library/azure/dn834998 を参照してください。 PUT (CreateOrReplace) 要求で必須。

properties.streamingUnits

integer

3

ストリーミング ジョブで使用されるストリーミング ユニットの数を指定します。

properties.validStreamingUnits

integer[]

ストリーミング ジョブがスケーリングできる有効なストリーミング ユニットを指定します。

type

string

リソースの種類