az stream-analytics input

Note

このリファレンスは、Azure CLI (バージョン 2.15.0 以降) の stream-analytics 拡張機能の一部です。 拡張機能は、az stream-analytics 入力コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

ストリーム分析を使用して入力を管理します。

コマンド

名前	説明	型	Status
az stream-analytics input create	入力を作成するか、既存のストリーミング ジョブの下にある既存の入力を置き換えます。	拡張	GA
az stream-analytics input delete	ストリーミング ジョブから入力を削除します。	拡張	GA
az stream-analytics input list	指定したストリーミング ジョブの下にあるすべての入力を一覧表示します。	拡張	GA
az stream-analytics input show	指定した入力に関する詳細を取得します。	拡張	GA
az stream-analytics input test	入力のデータソースに到達可能で、Azure Stream Analytics サービスで使用できるかどうかをテストします。	拡張	GA
az stream-analytics input update	既存のストリーミング ジョブの下にある既存の入力を更新します。 これは、ジョブまたは入力定義の残りの部分に影響を与えることなく、入力を部分的に更新 (つまり、1 つまたは 2 つのプロパティを更新) するために使用できます。	拡張	GA
az stream-analytics input wait	ストリーム分析入力の条件が満たされるまで、CLI を待機状態にします。	拡張	GA

az stream-analytics input create

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

az stream-analytics input create --input-name
                                 --job-name
                                 --resource-group
                                 [--if-match]
                                 [--if-none-match]
                                 [--properties]

例

CSV シリアル化を使用して参照 BLOB 入力を作成する

az stream-analytics input create --properties "{\"type\":\"Reference\",\"datasource\":{\"type\":\"Microsoft.Storage/Blob\",\"properties\":{\"container\":\"state\",\"dateFormat\":\"yyyy/MM/dd\",\"pathPattern\":\"{date}/{time}\",\"storageAccounts\":[{\"accountKey\":\"someAccountKey==\",\"accountName\":\"someAccountName\"}],\"timeFormat\":\"HH\"}},\"serialization\":{\"type\":\"Csv\",\"properties\":{\"encoding\":\"UTF8\",\"fieldDelimiter\":\",\"}}}" --input-name "input7225" --job-name "sj9597" --resource-group "sjrg8440"

JSON シリアル化を使用してストリーム Event Hub 入力を作成する

az stream-analytics input create --properties "{\"type\":\"Stream\",\"datasource\":{\"type\":\"Microsoft.ServiceBus/EventHub\",\"properties\":{\"consumerGroupName\":\"sdkconsumergroup\",\"eventHubName\":\"sdkeventhub\",\"serviceBusNamespace\":\"sdktest\",\"sharedAccessPolicyKey\":\"someSharedAccessPolicyKey==\",\"sharedAccessPolicyName\":\"RootManageSharedAccessKey\"}},\"serialization\":{\"type\":\"Json\",\"properties\":{\"encoding\":\"UTF8\"}}}" --input-name "input7425" --job-name "sj197" --resource-group "sjrg3139"

Avro シリアル化を使用してストリーム IoT Hub 入力を作成する

az stream-analytics input create --properties "{\"type\":\"Stream\",\"datasource\":{\"type\":\"Microsoft.Devices/IotHubs\",\"properties\":{\"consumerGroupName\":\"sdkconsumergroup\",\"endpoint\":\"messages/events\",\"iotHubNamespace\":\"iothub\",\"sharedAccessPolicyKey\":\"sharedAccessPolicyKey=\",\"sharedAccessPolicyName\":\"owner\"}},\"serialization\":{\"type\":\"Avro\"}}" --input-name "input7970" --job-name "sj9742" --resource-group "sjrg3467"

CSV シリアル化を使用してストリーム BLOB 入力を作成する

az stream-analytics input create --properties "{\"type\":\"Stream\",\"datasource\":{\"type\":\"Microsoft.Storage/Blob\",\"properties\":{\"container\":\"state\",\"dateFormat\":\"yyyy/MM/dd\",\"pathPattern\":\"{date}/{time}\",\"sourcePartitionCount\":16,\"storageAccounts\":[{\"accountKey\":\"someAccountKey==\",\"accountName\":\"someAccountName\"}],\"timeFormat\":\"HH\"}},\"serialization\":{\"type\":\"Csv\",\"properties\":{\"encoding\":\"UTF8\",\"fieldDelimiter\":\",\"}}}" --input-name "input8899" --job-name "sj6695" --resource-group "sjrg8161"

必須のパラメーター

--input-name --name -n

入力の名前。

--job-name

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

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--if-match

入力の ETag。 現在の入力を常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。

--if-none-match

新しい入力の作成を許可するが、既存の入力を更新できないようにするには、'*' に設定します。 その他の値は、412 の事前条件失敗応答になります。

--properties

入力に関連付けられているプロパティ。 PUT (CreateOrReplace) 要求で必要です。 予期される値: json-string/json-file/@json-file。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az stream-analytics input delete

ストリーミング ジョブから入力を削除します。

az stream-analytics input delete --input-name
                                 --job-name
                                 --resource-group
                                 [--yes]

例

入力を削除する

az stream-analytics input delete --input-name "input7225" --job-name "sj9597" --resource-group "sjrg8440"

必須のパラメーター

--input-name --name -n

入力の名前。

--job-name

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

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az stream-analytics input list

指定したストリーミング ジョブの下にあるすべての入力を一覧表示します。

az stream-analytics input list --job-name
                               --resource-group
                               [--select]

例

ストリーミング ジョブ内のすべての入力を一覧表示する

az stream-analytics input list --job-name "sj9597" --resource-group "sjrg8440"

$select OData クエリ パラメーターを使用して、ストリーミング ジョブ内のすべての入力を一覧表示し、診断情報を含めます

az stream-analytics input list --select "*" --job-name "sj7804" --resource-group "sjrg3276"

必須のパラメーター

--job-name

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

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--select

$select OData クエリ パラメーター。 これは、応答に含める構造プロパティのコンマ区切りの一覧です。または、すべてのプロパティを含める場合は "" です。既定では、診断を除くすべてのプロパティが返されます。現在、有効な値として受け入れるのは '' のみです。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az stream-analytics input show

指定した入力に関する詳細を取得します。

az stream-analytics input show --input-name
                               --job-name
                               --resource-group

例

CSV シリアル化を使用して参照 BLOB 入力を取得する

az stream-analytics input show --input-name "input7225" --job-name "sj9597" --resource-group "sjrg8440"

JSON シリアル化を使用してストリーム Event Hub 入力を取得する

az stream-analytics input show --input-name "input7425" --job-name "sj197" --resource-group "sjrg3139"

Avro シリアル化を使用して IoT Hub のストリーム入力を取得する

az stream-analytics input show --input-name "input7970" --job-name "sj9742" --resource-group "sjrg3467"

CSV シリアル化を使用してストリーム BLOB 入力を取得する

az stream-analytics input show --input-name "input8899" --job-name "sj6695" --resource-group "sjrg8161"

必須のパラメーター

--input-name --name -n

入力の名前。

--job-name

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

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az stream-analytics input test

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

az stream-analytics input test --input-name
                               --job-name
                               --resource-group
                               [--no-wait]
                               [--properties]

例

入力の接続をテストする

az stream-analytics input test --input-name "input7225" --job-name "sj9597" --resource-group "sjrg8440"

必須のパラメーター

--input-name --name -n

入力の名前。

--job-name

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

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--properties

入力に関連付けられているプロパティ。 PUT (CreateOrReplace) 要求で必要です。 予期される値: json-string/json-file/@json-file。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az stream-analytics input update

既存のストリーミング ジョブの下にある既存の入力を更新します。 これは、ジョブまたは入力定義の残りの部分に影響を与えることなく、入力を部分的に更新 (つまり、1 つまたは 2 つのプロパティを更新) するために使用できます。

az stream-analytics input update --input-name
                                 --job-name
                                 --resource-group
                                 [--if-match]
                                 [--properties]

例

参照 BLOB 入力を更新する

az stream-analytics input update --properties "{\"type\":\"Reference\",\"datasource\":{\"type\":\"Microsoft.Storage/Blob\",\"properties\":{\"container\":\"differentContainer\"}},\"serialization\":{\"type\":\"Csv\",\"properties\":{\"encoding\":\"UTF8\",\"fieldDelimiter\":\"|\"}}}" --input-name "input7225" --job-name "sj9597" --resource-group "sjrg8440"

Stream Event Hub の入力を更新する

az stream-analytics input update --properties "{\"type\":\"Stream\",\"datasource\":{\"type\":\"Microsoft.ServiceBus/EventHub\",\"properties\":{\"consumerGroupName\":\"differentConsumerGroupName\"}},\"serialization\":{\"type\":\"Avro\"}}" --input-name "input7425" --job-name "sj197" --resource-group "sjrg3139"

ストリーム IoT Hub 入力を更新する

az stream-analytics input update --properties "{\"type\":\"Stream\",\"datasource\":{\"type\":\"Microsoft.Devices/IotHubs\",\"properties\":{\"endpoint\":\"messages/operationsMonitoringEvents\"}},\"serialization\":{\"type\":\"Csv\",\"properties\":{\"encoding\":\"UTF8\",\"fieldDelimiter\":\"|\"}}}" --input-name "input7970" --job-name "sj9742" --resource-group "sjrg3467"

ストリーム BLOB 入力を更新する

az stream-analytics input update --properties "{\"type\":\"Stream\",\"datasource\":{\"type\":\"Microsoft.Storage/Blob\",\"properties\":{\"sourcePartitionCount\":32}},\"serialization\":{\"type\":\"Csv\",\"properties\":{\"encoding\":\"UTF8\",\"fieldDelimiter\":\"|\"}}}" --input-name "input8899" --job-name "sj6695" --resource-group "sjrg8161"

必須のパラメーター

--input-name --name -n

入力の名前。

--job-name

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

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--if-match

入力の ETag。 現在の入力を常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。

--properties

入力に関連付けられているプロパティ。 PUT (CreateOrReplace) 要求で必要です。 予期される値: json-string/json-file/@json-file。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az stream-analytics input wait

ストリーム分析入力の条件が満たされるまで、CLI を待機状態にします。

az stream-analytics input wait --input-name
                               --job-name
                               --resource-group
                               [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--interval]
                               [--timeout]
                               [--updated]

例

ストリーム分析入力が正常に作成されるまで、CLI スクリプトの次の行の実行を一時停止します。

az stream-analytics input wait --input-name "input8899" --job-name "sj6695" --resource-group "sjrg8161" --created

必須のパラメーター

--input-name --name -n

入力の名前。

--job-name

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

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False

--exists

リソースが存在するまで待ちます。

既定値: False

--interval

ポーリング間隔 (秒単位)。

既定値: 30

--timeout

最大待機時間 (秒単位)。

既定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。