az stream-analytics function
Note
このリファレンスは、Azure CLI (バージョン 2.15.0 以降) の stream-analytics 拡張機能の一部です。 拡張機能は、 az stream-analytics 関数 コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
ストリーム分析を使用して関数を管理します。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az stream-analytics function create |
既存のストリーミング ジョブの下に関数を作成するか、既存の関数を置き換えます。 |
拡張子 | GA |
az stream-analytics function delete |
ストリーミング ジョブから関数を削除します。 |
拡張子 | GA |
az stream-analytics function inspect |
指定されたパラメーターに基づいて、関数の既定の定義を取得します。 |
拡張子 | GA |
az stream-analytics function list |
指定したストリーミング ジョブのすべての関数を一覧表示します。 |
拡張子 | GA |
az stream-analytics function show |
指定した関数に関する詳細を取得します。 |
拡張子 | GA |
az stream-analytics function test |
関数に対して指定された情報が有効かどうかをテストします。 これは、関数の背後にある基になる Web サービスへの接続のテストや、指定された関数コードが構文的に正しいことを確認することまで多岐に渡ります。 |
拡張子 | GA |
az stream-analytics function update |
既存のストリーミング ジョブの下にある既存の関数を更新します。 これは、ジョブまたは関数定義の残りの部分に影響を与えることなく、関数を部分的に更新 (つまり、1 つまたは 2 つのプロパティを更新) するために使用できます。 |
拡張子 | GA |
az stream-analytics function wait |
ストリーム分析関数の条件が満たされるまで、CLI を待機状態にします。 |
拡張子 | GA |
az stream-analytics function create
既存のストリーミング ジョブの下に関数を作成するか、既存の関数を置き換えます。
az stream-analytics function create --function-name
--job-name
--resource-group
[--if-match]
[--if-none-match]
[--properties]
例
JavaScript 関数を作成する
az stream-analytics function create --properties "{\"type\":\"Scalar\",\"properties\":{\"binding\":{\"type\":\"Microsoft.StreamAnalytics/JavascriptUdf\",\"properties\":{\"script\":\"function (x, y) { return x + y; }\"}},\"inputs\":[{\"dataType\":\"Any\"}],\"output\":{\"dataType\":\"Any\"}}}" --function-name "function8197" --job-name "sj8653" --resource-group "sjrg1637"
Azure ML 関数を作成する
az stream-analytics function create --properties "{\"type\":\"Scalar\",\"properties\":{\"binding\":{\"type\":\"Microsoft.MachineLearning/WebService\",\"properties\":{\"apiKey\":\"someApiKey==\",\"batchSize\":1000,\"endpoint\":\"someAzureMLEndpointURL\",\"inputs\":{\"name\":\"input1\",\"columnNames\":[{\"name\":\"tweet\",\"dataType\":\"string\",\"mapTo\":0}]},\"outputs\":[{\"name\":\"Sentiment\",\"dataType\":\"string\"}]}},\"inputs\":[{\"dataType\":\"nvarchar(max)\"}],\"output\":{\"dataType\":\"nvarchar(max)\"}}}" --function-name "function588" --job-name "sj9093" --resource-group "sjrg7"
必須のパラメーター
関数の名前です。
ストリーミング ジョブの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
関数の ETag。 現在の関数を常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。
新しい関数を作成できるが、既存の関数を更新できないようにするには、'*' に設定します。 その他の値は、412 の事前条件失敗応答になります。
関数に関連付けられているプロパティ。 予期される値: json-string/json-file/@json-file。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az stream-analytics function delete
ストリーミング ジョブから関数を削除します。
az stream-analytics function delete --function-name
--job-name
--resource-group
[--yes]
例
関数を削除する
az stream-analytics function delete --name "function8197" --job-name "sj8653" --resource-group "sjrg1637"
必須のパラメーター
関数の名前です。
ストリーミング ジョブの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
確認のダイアログを表示しません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az stream-analytics function inspect
指定されたパラメーターに基づいて、関数の既定の定義を取得します。
az stream-analytics function inspect --function-name
--job-name
--resource-group
[--ml-properties]
必須のパラメーター
関数の名前です。
ストリーミング ジョブの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
Azure Machine Learning Web サービス関数の既定の関数定義を取得するために必要なパラメーター。
使用法: --ml-properties execute-endpoint=XX
execute-endpoint: Azure Machine Learning Web サービスの Request-Response 実行エンドポイント。 詳細については、以下をご覧ください: https://docs.microsoft.com/en-us/azure/stream-analytics/machine-learning-udf。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az stream-analytics function list
指定したストリーミング ジョブのすべての関数を一覧表示します。
az stream-analytics function list --job-name
--resource-group
[--select]
例
ストリーミング ジョブ内のすべての関数を一覧表示する
az stream-analytics function list --job-name "sj8653" --resource-group "sjrg1637"
必須のパラメーター
ストリーミング ジョブの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
$select OData クエリ パラメーター。 これは、応答に含める構造プロパティのコンマ区切りのリスト、またはすべてのプロパティを含める "" です。既定では、診断を除くすべてのプロパティが返されます。現在、'' のみを有効な値として受け入れます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az stream-analytics function show
指定した関数に関する詳細を取得します。
az stream-analytics function show --function-name
--job-name
--resource-group
例
JavaScript 関数を取得する
az stream-analytics function show --name "function8197" --job-name "sj8653" --resource-group "sjrg1637"
Azure ML 関数を取得する
az stream-analytics function show --name "function588" --job-name "sj9093" --resource-group "sjrg7"
必須のパラメーター
関数の名前です。
ストリーミング ジョブの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az stream-analytics function test
関数に対して指定された情報が有効かどうかをテストします。 これは、関数の背後にある基になる Web サービスへの接続のテストや、指定された関数コードが構文的に正しいことを確認することまで多岐に渡ります。
az stream-analytics function test --function-name
--job-name
--resource-group
[--no-wait]
[--properties]
例
JavaScript 関数の接続をテストする
az stream-analytics function test --function-name "function8197" --job-name "sj8653" --resource-group "sjrg1637"
Azure ML 関数の接続をテストする
az stream-analytics function test --function-name "function588" --job-name "sj9093" --resource-group "sjrg7"
必須のパラメーター
関数の名前です。
ストリーミング ジョブの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
実行時間の長い操作の終了を待機しません。
関数に関連付けられているプロパティ。 予期される値: json-string/json-file/@json-file。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az stream-analytics function update
既存のストリーミング ジョブの下にある既存の関数を更新します。 これは、ジョブまたは関数定義の残りの部分に影響を与えることなく、関数を部分的に更新 (つまり、1 つまたは 2 つのプロパティを更新) するために使用できます。
az stream-analytics function update --function-name
--job-name
--resource-group
[--if-match]
[--properties]
例
JavaScript 関数を更新する
az stream-analytics function update --properties "{\"type\":\"Scalar\",\"properties\":{\"binding\":{\"type\":\"Microsoft.StreamAnalytics/JavascriptUdf\",\"properties\":{\"script\":\"function (a, b) { return a * b; }\"}}}}" --function-name "function8197" --job-name "sj8653" --resource-group "sjrg1637"
Azure ML 関数を更新する
az stream-analytics function update --properties "{\"type\":\"Scalar\",\"properties\":{\"binding\":{\"type\":\"Microsoft.MachineLearning/WebService\",\"properties\":{\"batchSize\":5000}}}}" --function-name "function588" --job-name "sj9093" --resource-group "sjrg7"
必須のパラメーター
関数の名前です。
ストリーミング ジョブの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
関数の ETag。 現在の関数を常に上書きするには、この値を省略します。 同時変更が誤って上書きされないように、最後に表示された ETag 値を指定します。
関数に関連付けられているプロパティ。 予期される値: json-string/json-file/@json-file。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az stream-analytics function wait
ストリーム分析関数の条件が満たされるまで、CLI を待機状態にします。
az stream-analytics function wait --function-name
--job-name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
例
stream-analytics 関数が正常に作成されるまで、CLI スクリプトの次の行の実行を一時停止します。
az stream-analytics function wait --name "function588" --job-name "sj9093" --resource-group "sjrg7" --created
必須のパラメーター
関数の名前です。
ストリーミング ジョブの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
削除されるまで待ちます。
リソースが存在するまで待ちます。
ポーリング間隔 (秒単位)。
最大待機時間 (秒単位)。
provisioningState が 'Succeeded' で更新されるまで待ちます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI