Share via

az stream-analytics output

  • 參考

注意

此參考是 Azure CLI 串流分析 延伸模組的一部分 （2.15.0 版或更高版本）。 擴充功能會在您第一次執行 az stream-analytics 輸出 命令時自動安裝。 深入了解擴充功能。

使用串流分析管理輸出。

命令

名稱 Description 類型 狀態
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 串流分析服務存取及使用。

 副檔名 GA
az stream-analytics output update

在現有的串流作業下更新現有的輸出。 這可以用來部分更新 （即更新一或兩個屬性） 輸出，而不會影響其餘的作業或輸出定義。

 副檔名 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 串行化建立 服務匯流排 佇列輸出

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 串行化建立 服務匯流排 主題輸出

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

要限制串流分析輸出的大小視窗。

--time-window

篩選串流分析作業輸出的時間範圍。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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 串行化取得 服務匯流排 佇列輸出

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

使用 CSV 串行化取得 服務匯流排 主題輸出

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 數據倉儲輸出

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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az stream-analytics output test

測試輸出的數據源是否可供 Azure 串流分析服務存取及使用。

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

要限制串流分析輸出的大小視窗。

--time-window

篩選串流分析作業輸出的時間範圍。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az stream-analytics output update

在現有的串流作業下更新現有的輸出。 這可以用來部分更新 （即更新一或兩個屬性） 輸出，而不會影響其餘的作業或輸出定義。

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 串行化更新 服務匯流排 佇列輸出

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 串行化更新 服務匯流排 主題輸出

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 串行化更新事件中樞輸出

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

要限制串流分析輸出的大小視窗。

--time-window

篩選串流分析作業輸出的時間範圍。

全域參數
--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 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

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: 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

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。