Inputs - Test

入力のデータソースに到達可能で、Azure Stream Analytics サービスで使用できるかどうかをテストします。

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

URI パラメーター

名前 / 必須 説明
inputName
path True

string

入力の名前。

jobName
path True

string

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

resourceGroupName
path True

string

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

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

subscriptionId
path True

string

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

api-version
query True

string

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

要求本文

名前 説明
name

string

リソース名

properties InputProperties:

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

応答

名前 説明
200 OK

ResourceTestStatus

テスト操作が正常に完了しました。

202 Accepted

テスト要求が正常に開始されました。

Other Status Codes

Error

エラー。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

Test the connection for an input

要求のサンプル

POST https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225/test?api-version=2020-03-01

応答のサンプル

{
  "status": "TestSucceeded"
}

定義

名前 説明
AuthenticationMode

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

AvroSerialization

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

AzureSqlReferenceInputDataSource

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

BlobReferenceInputDataSource

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

BlobStreamInputDataSource

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

Compression

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

CompressionType

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

CsvSerialization

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

DiagnosticCondition

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

Diagnostics

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

Encoding

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

Error

一般的なエラー表現。

ErrorResponse

発生したエラーについて説明します。

EventHubStreamInputDataSource

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

EventHubV2StreamInputDataSource

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

EventSerializationType

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

FileReferenceInputDataSource

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

GatewayMessageBusStreamInputDataSource

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

Input

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

IoTHubStreamInputDataSource

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

JsonOutputSerializationFormat

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

JsonSerialization

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

ParquetSerialization

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

ReferenceInputProperties

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

RefreshType

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

ResourceTestStatus

テスト操作の状態とエラー情報 (該当する場合) について説明します。

StorageAccount

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

StreamInputProperties

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

AuthenticationMode

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

名前 説明
ConnectionString

string

Msi

string

UserToken

string

AvroSerialization

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

名前 説明
type string:

Avro

入力または出力で使用されるシリアル化の種類を示します。 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) 要求で必須。

BlobReferenceInputDataSource

参照データを含む 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.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-output を参照https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-inputしてください。

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

Compression

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

名前 規定値 説明
type

CompressionType

None

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

CompressionType

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

名前 説明
Deflate

string

GZip

string

None

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 個以上の条件のコレクション。

Encoding

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

名前 説明
UTF8

string

Error

一般的なエラー表現。

名前 説明
error

Error

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

ErrorResponse

発生したエラーについて説明します。

名前 説明
code

string

発生したエラーに関連付けられているエラー コード。

message

string

エラーについて詳しく説明します。

EventHubStreamInputDataSource

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

名前 規定値 説明
authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.consumerGroupName

string

イベント ハブからイベントを読み取るために使用する必要があるイベント ハブ コンシューマー グループの名前。 複数の入力に対して個別のコンシューマー グループ名を指定すると、これらの各入力でイベント ハブから同じイベントを受信できます。 指定しない場合、入力では 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) 要求で必要です。

EventHubV2StreamInputDataSource

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

名前 規定値 説明
authenticationMode

AuthenticationMode

ConnectionString

認証モード。

properties.consumerGroupName

string

イベント ハブからイベントを読み取るために使用する必要があるイベント ハブ コンシューマー グループの名前。 複数の入力に対して個別のコンシューマー グループ名を指定すると、これらの各入力でイベント ハブから同じイベントを受信できます。 指定しない場合、入力では 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

FileReferenceInputDataSource

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

名前 説明
properties.path

string

ファイルのパス。

type string:

File

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

GatewayMessageBusStreamInputDataSource

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

名前 説明
properties.topic

string

Service Bus トピックの名前。

type string:

GatewayMessageBus

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

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

JsonOutputSerializationFormat

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

名前 説明
Array

string

LineSeparated

string

JsonSerialization

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

名前 説明
properties.encoding

Encoding

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

properties.format

JsonOutputSerializationFormat

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

type string:

Json

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

ParquetSerialization

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

名前 説明
type string:

Parquet

入力または出力で使用されるシリアル化の種類を示します。 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

ResourceTestStatus

テスト操作の状態とエラー情報 (該当する場合) について説明します。

名前 説明
error

ErrorResponse

発生したエラーについて説明します。

status

string

テスト操作の状態。

StorageAccount

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

名前 説明
accountKey

string

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

accountName

string

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

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