次の方法で共有


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

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

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

subscriptionId
path True

string

minLength: 1

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

api-version
query True

string

minLength: 1

この操作に使用する 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

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

properties.eventsLateArrivalMaxDelayInSeconds

integer (int32)

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

properties.eventsOutOfOrderMaxDelayInSeconds

integer (int32)

順序外のイベントを順番に戻すように調整できる最大許容遅延 (秒単位)。

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 (date-time)

値は、出力イベント ストリームの開始点を示す 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

イベント ハブの出力データ ソースについて説明します。

EventHubStreamInputDataSource

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

EventHubV2OutputDataSource

イベント ハブの出力データ ソースについて説明します。

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' です。

説明
Msi
UserToken
ConnectionString

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 関数を使用する場合は、関数にアクセスするためのキーを指定することで使用できます。

properties.functionAppName

string

Azure Functions アプリの名前。

properties.functionName

string

Azure Functions アプリ内の関数の名前。

properties.maxBatchCount

number

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

properties.maxBatchSize

number

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

type string:

Microsoft.AzureFunction

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

AzureMachineLearningWebServiceFunctionBinding

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

名前 説明
properties.apiKey

string

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

properties.batchSize

integer (int32)

各 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 (int32)

この入力がマップされる関数パラメーターの 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 Database インスタンスへの接続に使用されるパスワードです。

properties.refreshRate

string

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

properties.refreshType

RefreshType

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

properties.server

string

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

properties.table

string

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

properties.user

string

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

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 Storage アカウントの名前。 PUT (CreateOrReplace) 要求で必要です。

properties.batchSize

integer (int32)

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

日付形式。 {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) 要求で必要です。

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

日付形式。 {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.sourcePartitionCount

integer (int32)

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
1.2

Compression

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

名前 規定値 説明
type

CompressionType

None

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

CompressionType

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

説明
None
GZip
Deflate

ContentStoragePolicy

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

説明
SystemAccount
JobStorageAccount

CsvSerialization

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

名前 説明
properties.encoding

Encoding

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

properties.fieldDelimiter

string

コンマ区切り値 (CSV) レコードを区切るために使用する区切り記号を指定します。 サポートされている値の一覧については、https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input または https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output を参照してください。 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 から始まります。 詳細については、https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output の DocumentDB セクションを参照してください。 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

Error

一般的なエラー表現。

名前 説明
error

Error

エラー定義プロパティ。

EventHubOutputDataSource

イベント ハブの出力データ ソースについて説明します。

名前 規定値 説明
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

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

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

イベント ハブの出力データ ソースについて説明します。

名前 規定値 説明
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

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

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) 要求で必要です。

説明
Csv
Avro
Json
Parquet

EventsOutOfOrderPolicy

入力イベント ストリームで順不同に到着するイベントに適用するポリシーを示します。

説明
Adjust
Drop

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

identity 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/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 Storage アカウントの名前。 PUT (CreateOrReplace) 要求で必要です。

authenticationMode

AuthenticationMode

ConnectionString

認証モード。

JobType

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

説明
Cloud
Edge

JsonOutputSerializationFormat

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

説明
LineSeparated
Array

JsonSerialization

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

名前 説明
properties.encoding

Encoding

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

properties.format

JsonOutputSerializationFormat

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

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

properties.timeWindow

string

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

type

string

リソースの種類

OutputErrorPolicy

出力に到着し、形式が正しくないために外部ストレージに書き込むことができないイベントに適用するポリシーを示します (列の値がない、列の値が間違っている、またはサイズが正しくありません)。

説明
Stop
Drop

OutputStartMode

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

説明
JobStartTime
CustomTime
LastOutputEventTime

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

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

説明
Static
RefreshPeriodicallyWithFull
RefreshPeriodicallyWithDelta

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

StorageAccount

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

名前 説明
accountKey

string

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

accountName

string

Azure Storage アカウントの名前。 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 (date-time)

値は、ストリーミング ジョブの作成時を示す ISO-8601 形式の UTC タイムスタンプです。

properties.dataLocale

string

ストリーム分析ジョブのデータ ロケール。 値は、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 (int32)

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

properties.eventsOutOfOrderMaxDelayInSeconds

integer (int32)

順序外のイベントを順番に戻すように調整できる最大許容遅延 (秒単位)。

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 (date-time)

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

properties.outputErrorPolicy

OutputErrorPolicy

出力に到着し、形式が正しくないために外部ストレージに書き込むことができないイベントに適用するポリシーを示します (列の値がない、列の値が間違っている、またはサイズが正しくありません)。

properties.outputStartMode

OutputStartMode

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

properties.outputStartTime

string (date-time)

値は、出力イベント ストリームの開始点を示す 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 (int32)

3

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

properties.validStreamingUnits

integer[] (int32)

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

type

string

リソースの種類