az stream-analytics output

Note

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

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

コマンド

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

az stream-analytics output create

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

az stream-analytics output create --job-name
                                  --name
                                  --resource-group
                                  [--datasource]
                                  [--if-match]
                                  [--if-none-match]
                                  [--serialization]
                                  [--size-window]
                                  [--time-window]

例

DocumentDB 出力を作成する

az stream-analytics output create --job-name "sj2331" --datasource "{\"type\":\"Microsoft.Storage/DocumentDB\",\"properties\":{\"accountId\":\"someAccountId\",\"accountKey\":\"accountKey==\",\"collectionNamePattern\":\"collection\",\"database\":\"db01\",\"documentId\":\"documentId\",\"partitionKey\":\"key\"}}" --output-name "output3022" --resource-group "sjrg7983"

Power BI 出力を作成する

az stream-analytics output create --job-name "sj2331" --datasource "{\"type\":\"PowerBI\",\"properties\":{\"dataset\":\"someDataset\",\"groupId\":\"ac40305e-3e8d-43ac-8161-c33799f43e95\",\"groupName\":\"MyPowerBIGroup\",\"refreshToken\":\"someRefreshToken==\",\"table\":\"someTable\",\"tokenUserDisplayName\":\"Bob Smith\",\"tokenUserPrincipalName\":\"bobsmith@contoso.com\"}}" --output-name "output3022" --resource-group "sjrg7983"

Avro シリアル化を使用して Service Bus キューの出力を作成する

az stream-analytics output create --job-name "sj5095" --datasource "{\"type\":\"Microsoft.ServiceBus/Queue\",\"properties\":{\"propertyColumns\":[\"column1\",\"column2\"],\"queueName\":\"sdkqueue\",\"serviceBusNamespace\":\"sdktest\",\"sharedAccessPolicyKey\":\"sharedAccessPolicyKey=\",\"sharedAccessPolicyName\":\"RootManageSharedAccessKey\",\"systemPropertyColumns\":{\"MessageId\":\"col3\",\"PartitionKey\":\"col4\"}}}" --serialization "{\"type\":\"Avro\"}" --output-name "output3456" --resource-group "sjrg3410"

CSV シリアル化を使用して Service Bus トピックの出力を作成する

az stream-analytics output create --job-name "sj7094" --datasource "{\"type\":\"Microsoft.ServiceBus/Topic\",\"properties\":{\"propertyColumns\":[\"column1\",\"column2\"],\"serviceBusNamespace\":\"sdktest\",\"sharedAccessPolicyKey\":\"sharedAccessPolicyKey=\",\"sharedAccessPolicyName\":\"RootManageSharedAccessKey\",\"topicName\":\"sdktopic\"}}" --serialization "{\"type\":\"Csv\",\"properties\":{\"encoding\":\"UTF8\",\"fieldDelimiter\":\",\"}}" --output-name "output7886" --resource-group "sjrg6450"

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

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

JSON シリアル化を使用して Azure Data Lake Store 出力を作成する

az stream-analytics output create --job-name "sj3310" --datasource "{\"type\":\"Microsoft.DataLake/Accounts\",\"properties\":{\"accountName\":\"someaccount\",\"dateFormat\":\"yyyy/MM/dd\",\"filePathPrefix\":\"{date}/{time}\",\"refreshToken\":\"someRefreshToken==\",\"tenantId\":\"cea4e98b-c798-49e7-8c40-4a2b3beb47dd\",\"timeFormat\":\"HH\",\"tokenUserDisplayName\":\"Bob Smith\",\"tokenUserPrincipalName\":\"bobsmith@contoso.com\"}}" --serialization "{\"type\":\"Json\",\"properties\":{\"format\":\"Array\",\"encoding\":\"UTF8\"}}" --output-name "output5195" --resource-group "sjrg6912"

Azure SQL データベースの出力を作成する

az stream-analytics output create --job-name "sj6458" --datasource "{\"type\":\"Microsoft.Sql/Server/Database\",\"properties\":{\"database\":\"someDatabase\",\"password\":\"somePassword\",\"server\":\"someServer\",\"table\":\"someTable\",\"user\":\"<user>\"}}" --output-name "output1755" --resource-group "sjrg2157"

Azure テーブルの出力を作成する

az stream-analytics output create --job-name "sj2790" --datasource "{\"type\":\"Microsoft.Storage/Table\",\"properties\":{\"accountKey\":\"accountKey==\",\"accountName\":\"someAccountName\",\"batchSize\":25,\"columnsToRemove\":[\"column1\",\"column2\"],\"partitionKey\":\"partitionKey\",\"rowKey\":\"rowKey\",\"table\":\"samples\"}}" --output-name "output958" --resource-group "sjrg5176"

JSON シリアル化を使用してイベント ハブの出力を作成する

az stream-analytics output create --job-name "sj3310" --datasource "{\"type\":\"Microsoft.ServiceBus/EventHub\",\"properties\":{\"eventHubName\":\"sdkeventhub\",\"partitionKey\":\"partitionKey\",\"serviceBusNamespace\":\"sdktest\",\"sharedAccessPolicyKey\":\"sharedAccessPolicyKey=\",\"sharedAccessPolicyName\":\"RootManageSharedAccessKey\"}}" --serialization "{\"type\":\"Json\",\"properties\":{\"format\":\"Array\",\"encoding\":\"UTF8\"}}" --output-name "output5195" --resource-group "sjrg6912"

必須のパラメーター

--job-name

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

--name --output-name -n

出力の名前。

--resource-group -g

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

省略可能のパラメーター

--datasource

出力の書き込み先となるデータ ソースについて説明します。 PUT (CreateOrReplace) 要求で必要です。 予期される値: json-string/json-file/@json-file。

--if-match

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

--if-none-match

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

--serialization

入力からのデータをシリアル化する方法、または出力に書き込むときにデータをシリアル化する方法について説明します。 PUT (CreateOrReplace) 要求で必要です。 予期される値: json-string/json-file/@json-file。

--size-window

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

--time-window

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

グローバル パラメーター

--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 output delete

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

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

例

出力を削除する

az stream-analytics output delete --job-name "sj6458" --name "output1755" --resource-group "sjrg2157"

必須のパラメーター

--job-name

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

--name --output-name -n

出力の名前。

--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 output list

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

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

例

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

az stream-analytics output list --job-name "sj6458" --resource-group "sjrg2157"

必須のパラメーター

--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 output show

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

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

例

DocumentDB の出力を取得する

az stream-analytics output show --job-name "sj2331" --output-name "output3022" --resource-group "sjrg7983"

Power BI の出力を取得する

az stream-analytics output show --job-name "sj2331" --output-name "output3022" --resource-group "sjrg7983"

Avro シリアル化を使用して Service Bus キューの出力を取得する

az stream-analytics output show --job-name "sj5095" --output-name "output3456" --resource-group "sjrg3410"

CSV シリアル化を使用して Service Bus トピックの出力を取得する

az stream-analytics output show --job-name "sj7094" --output-name "output7886" --resource-group "sjrg6450"

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

az stream-analytics output show --job-name "sj900" --output-name "output1623" --resource-group "sjrg5023"

JSON シリアル化を使用して Azure Data Lake Store の出力を取得する

az stream-analytics output show --job-name "sj3310" --output-name "output5195" --resource-group "sjrg6912"

Azure Data Warehouse の出力を取得する

az stream-analytics output show --job-name "sjName" --output-name "output958" --resource-group "sjrg"

Azure SQL データベースの出力を取得する

az stream-analytics output show --job-name "sj6458" --output-name "output1755" --resource-group "sjrg2157"

Azure テーブルの出力を取得する

az stream-analytics output show --job-name "sj2790" --output-name "output958" --resource-group "sjrg5176"

JSON シリアル化を使用してイベント ハブの出力を取得する

az stream-analytics output show --job-name "sj3310" --output-name "output5195" --resource-group "sjrg6912"

必須のパラメーター

--job-name

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

--name --output-name -n

出力の名前。

--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 output test

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

az stream-analytics output test --job-name
                                --name
                                --resource-group
                                [--datasource]
                                [--no-wait]
                                [--serialization]
                                [--size-window]
                                [--time-window]

例

出力の接続をテストする

az stream-analytics output test --job-name "sj6458" --output-name "output1755" --resource-group "sjrg2157"

必須のパラメーター

--job-name

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

--name --output-name -n

出力の名前。

--resource-group -g

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

省略可能のパラメーター

--datasource

出力の書き込み先となるデータ ソースについて説明します。 PUT (CreateOrReplace) 要求で必要です。 予期される値: json-string/json-file/@json-file。

--no-wait

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

既定値: False

--serialization

入力からのデータをシリアル化する方法、または出力に書き込むときにデータをシリアル化する方法について説明します。 PUT (CreateOrReplace) 要求で必要です。 予期される値: json-string/json-file/@json-file。

--size-window

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

--time-window

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

グローバル パラメーター

--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 output update

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

az stream-analytics output update --job-name
                                  --name
                                  --resource-group
                                  [--datasource]
                                  [--if-match]
                                  [--serialization]
                                  [--size-window]
                                  [--time-window]

例

DocumentDB の出力を更新する

az stream-analytics output update --job-name "sj2331" --datasource "{\"type\":\"Microsoft.Storage/DocumentDB\",\"properties\":{\"partitionKey\":\"differentPartitionKey\"}}" --output-name "output3022" --resource-group "sjrg7983"

Power BI 出力を更新する

az stream-analytics output update --job-name "sj2331" --datasource "{\"type\":\"PowerBI\",\"properties\":{\"dataset\":\"differentDataset\"}}" --output-name "output3022" --resource-group "sjrg7983"

Avro シリアル化を使用して Service Bus キューの出力を更新する

az stream-analytics output update --job-name "sj5095" --datasource "{\"type\":\"Microsoft.ServiceBus/Queue\",\"properties\":{\"queueName\":\"differentQueueName\"}}" --serialization "{\"type\":\"Json\",\"properties\":{\"format\":\"LineSeparated\",\"encoding\":\"UTF8\"}}" --output-name "output3456" --resource-group "sjrg3410"

CSV シリアル化を使用して Service Bus トピックの出力を更新する

az stream-analytics output update --job-name "sj7094" --datasource "{\"type\":\"Microsoft.ServiceBus/Topic\",\"properties\":{\"topicName\":\"differentTopicName\"}}" --serialization "{\"type\":\"Csv\",\"properties\":{\"encoding\":\"UTF8\",\"fieldDelimiter\":\"|\"}}" --output-name "output7886" --resource-group "sjrg6450"

CSV シリアル化を使用して BLOB 出力を更新する

az stream-analytics output update --job-name "sj900" --datasource "{\"type\":\"Microsoft.Storage/Blob\",\"properties\":{\"container\":\"differentContainer\"}}" --serialization "{\"type\":\"Csv\",\"properties\":{\"encoding\":\"UTF8\",\"fieldDelimiter\":\"|\"}}" --output-name "output1623" --resource-group "sjrg5023"

JSON シリアル化を使用して Azure Data Lake Store の出力を更新する

az stream-analytics output update --job-name "sj3310" --datasource "{\"type\":\"Microsoft.DataLake/Accounts\",\"properties\":{\"accountName\":\"differentaccount\"}}" --serialization "{\"type\":\"Json\",\"properties\":{\"format\":\"LineSeparated\",\"encoding\":\"UTF8\"}}" --output-name "output5195" --resource-group "sjrg6912"

Azure SQL データベースの出力を更新する

az stream-analytics output update --job-name "sj6458" --datasource "{\"type\":\"Microsoft.Sql/Server/Database\",\"properties\":{\"table\":\"differentTable\"}}" --output-name "output1755" --resource-group "sjrg2157"

Azure テーブルの出力を更新する

az stream-analytics output update --job-name "sj2790" --datasource "{\"type\":\"Microsoft.Storage/Table\",\"properties\":{\"partitionKey\":\"differentPartitionKey\"}}" --output-name "output958" --resource-group "sjrg5176"

JSON シリアル化を使用して Event Hub の出力を更新する

az stream-analytics output update --job-name "sj3310" --datasource "{\"type\":\"Microsoft.ServiceBus/EventHub\",\"properties\":{\"partitionKey\":\"differentPartitionKey\"}}" --serialization "{\"type\":\"Json\",\"properties\":{\"format\":\"LineSeparated\",\"encoding\":\"UTF8\"}}" --output-name "output5195" --resource-group "sjrg6912"

必須のパラメーター

--job-name

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

--name --output-name -n

出力の名前。

--resource-group -g

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

省略可能のパラメーター

--datasource

出力の書き込み先となるデータ ソースについて説明します。 PUT (CreateOrReplace) 要求で必要です。 予期される値: json-string/json-file/@json-file。

--if-match

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

--serialization

入力からのデータをシリアル化する方法、または出力に書き込むときにデータをシリアル化する方法について説明します。 PUT (CreateOrReplace) 要求で必要です。 予期される値: json-string/json-file/@json-file。

--size-window

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

--time-window

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

グローバル パラメーター

--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 output wait

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

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

例

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

az stream-analytics output wait --job-name "sj3310" --output-name "output5195" --resource-group "sjrg6912" --created

必須のパラメーター

--job-name

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

--name --output-name -n

出力の名前。

--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 を使います。