az stream-analytics job
注意
此參考是 Azure CLI 串流分析延伸模組的一部分(2.15.0 版或更高版本)。 擴充功能會在您第一次執行 az stream-analytics 作業 命令時自動安裝。 深入了解擴充功能。
使用串流分析管理串流作業。
命令
名稱 | Description | 類型 | 狀態 |
---|---|---|---|
az stream-analytics job create |
建立串流作業,或取代已經存在的串流作業。 |
副檔名 | GA |
az stream-analytics job delete |
刪除串流作業。 |
副檔名 | GA |
az stream-analytics job list |
列出指定資源群組中的所有串流作業。 並列出指定訂用帳戶中的所有串流作業。 |
副檔名 | GA |
az stream-analytics job scale |
在作業執行時調整串流作業。 |
副檔名 | GA |
az stream-analytics job show |
取得指定串流作業的詳細數據。 |
副檔名 | GA |
az stream-analytics job start |
啟動串流作業。 一旦作業啟動,它就會開始處理輸入事件並產生輸出。 |
副檔名 | GA |
az stream-analytics job stop |
停止執行中的串流作業。 這會導致執行中的串流作業停止處理輸入事件並產生輸出。 |
副檔名 | GA |
az stream-analytics job update |
更新現有的串流作業。 這可以用來部分更新 (即更新一或兩個屬性) 串流作業,而不會影響其餘的作業定義。 |
副檔名 | GA |
az stream-analytics job wait |
將 CLI 置於等候狀態,直到符合串流分析作業的條件為止。 |
副檔名 | GA |
az stream-analytics job create
建立串流作業,或取代已經存在的串流作業。
az stream-analytics job create --job-name
--resource-group
[--arrival-max-delay]
[--compatibility-level {1.0, 1.2}]
[--content-storage-policy {JobStorageAccount, SystemAccount}]
[--data-locale]
[--functions]
[--id]
[--identity]
[--if-match]
[--if-none-match]
[--inputs]
[--job-storage-account]
[--job-type {Cloud, Edge}]
[--location]
[--no-wait]
[--order-max-delay]
[--out-of-order-policy {Adjust, Drop}]
[--output-error-policy {Drop, Stop}]
[--output-start-mode {CustomTime, JobStartTime, LastOutputEventTime}]
[--output-start-time]
[--outputs]
[--tags]
[--transformation]
範例
建立完整的串流作業(具有轉換的串流作業、至少 1 個輸入和至少 1 個輸出)
az stream-analytics job create --job-name "sj7804" --resource-group "sjrg3276" --location "West US" --compatibility-level "1.0" --data-locale "en-US" --arrival-max-delay 5 --order-max-delay 0 --out-of-order-policy "Drop" --functions "[]" --inputs "[{\"name\":\"inputtest\",\"properties\":{\"type\":\"Stream\",\"datasource\":{\"type\":\"Microsoft.Storage/Blob\",\"properties\":{\"container\":\"containerName\",\"pathPattern\":\"\",\"storageAccounts\":[{\"accountKey\":\"yourAccountKey==\",\"accountName\":\"yourAccountName\"}]}},\"serialization\":{\"type\":\"Json\",\"properties\":{\"encoding\":\"UTF8\"}}}}]" --output-error-policy "Drop" --outputs "[{\"name\":\"outputtest\",\"datasource\":{\"type\":\"Microsoft.Sql/Server/Database\",\"properties\":{\"database\":\"databaseName\",\"password\":\"userPassword\",\"server\":\"serverName\",\"table\":\"tableName\",\"user\":\"<user>\"}}}]" --transformation name="transformationtest" streaming-units=1 query="Select Id, Name from inputtest" --tags key1="value1" key3="value3" randomKey="randomValue"
建立串流作業殼層 (沒有輸入、輸出、轉換或函式的串流作業)
az stream-analytics job create --job-name "sj59" --resource-group "sjrg6936" --location "West US" --compatibility-level "1.0" --data-locale "en-US" --arrival-max-delay 16 --order-max-delay 5 --out-of-order-policy "Drop" --functions "[]" --inputs "[]" --output-error-policy "Drop" --outputs "[]" --tags key1="value1" key3="value3" randomKey="randomValue"
必要參數
串流作業的名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
可容許延遲上限 (以秒為單位),其中可能會包含延遲抵達的事件。 支援的範圍是 -1 到 1814399 (20.23:59:59:59 天)和 -1 用來無限期指定等候。 如果屬性不存在,則會解譯為值為 -1。
控制串流處理工作的某些執行時間行為。
有效值為JobStorageAccount和 SystemAccount。 如果設定為 JobStorageAccount,這需要使用者也指定 jobStorageAccount 屬性。 .
串流分析作業的資料地區設定。 值應該是集合 https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx中支援的 .NET 文化特性名稱。 如果未指定則預設為 'en-US'。
串流作業的一或多個函式清單。 在 PUT 要求中指定此屬性時,需要每個函式的 name 屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別轉換的 PATCH API。 預期值:json-string/json-file/@json-file。
叢集的資源標識碼。
描述指派給此作業的系統指派受控識別,可用來向輸入和輸出進行驗證。
使用量:--identity tenant-id=XX principal-id=XX type=XX
tenant-id:identity tenantId principal-id:身分識別主體標識符類型:身分識別類型。
串流作業的 ETag。 請省略此值,以一律覆寫目前的記錄集。 指定最後看到的 ETag 值,以防止意外覆寫並行變更。
設定為 『*』 以允許建立新的串流作業,但為了避免更新現有的記錄集。 其他值會導致 412 前置條件失敗的回應。
串流作業的一或多個輸入清單。 在 PUT 要求中指定此屬性時,需要每個輸入的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可供個別輸入使用的 PATCH API。 預期值:json-string/json-file/@json-file。
與具有 MSI 之 Azure 儲存體 帳戶相關聯的屬性。
使用量:--job-storage-account authentication-mode=XX account-name=XX account-key=XX
authentication-mode:驗證模式。 account-name:Azure 儲存體 帳戶的名稱。 PUT (CreateOrReplace) 要求的必要專案。 account-key:Azure 儲存體 帳戶的帳戶密鑰。 PUT (CreateOrReplace) 要求的必要專案。
描述作業的類型。 有效的模式為 Cloud
和 『Edge』。
位置。 值的來源:az account list-locations
。 您可以使用 az configure --defaults location=<location>
設定預設位置。
請勿等候長時間執行的作業完成。
可容許延遲上限 (以秒為單位),其中可以將順序錯亂的事件調整回原有順序。
指出要套用至輸入事件串流中未按順序送達之事件的原則。
指出要套用至抵達輸出的事件,而且由於格式不正確而無法寫入外部記憶體的原則(遺漏數據行值、類型錯誤或大小的數據行值)。
只有當想要在建立時立即啟動作業時,才應該使用這個屬性。 值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指出輸出事件數據流的起點應該在每次啟動作業時啟動、從透過 outputStartTime 屬性指定的自定義用戶時間戳開始,或從最後一個事件輸出時間開始。
值是 ISO-8601 格式化的時間戳,表示輸出事件數據流的起點,或 Null,表示每當串流作業啟動時,輸出事件數據流就會啟動。 如果 outputStartMode 設定為 CustomTime,這個屬性就必須有值。
串流作業的一或多個輸出清單。 在 PUT 要求中指定此屬性時,需要每個輸出的 name 屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別輸出的 PATCH API。 預期值:json-string/json-file/@json-file。
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。
指出要用於串流作業的查詢和串流單位數目。 在 PUT 要求中指定這個屬性時,需要轉換的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別轉換的 PATCH API。
使用方式:--transformation streaming-units=XX valid-streaming-units=XX query=XX name=XX
串流單位:指定串流作業所使用的串流單位數目。 valid-streaming-units:指定串流作業可調整為的有效串流單位。query:指定將在串流作業中執行的查詢。 您可以在這裏深入瞭解串流分析查詢語言(SAQL: https://msdn.microsoft.com/library/azure/dn834998 )。 PUT (CreateOrReplace) 要求的必要專案。 name:資源名稱。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stream-analytics job delete
刪除串流作業。
az stream-analytics job delete --job-name
--resource-group
[--no-wait]
[--yes]
範例
刪除串流作業
az stream-analytics job delete --job-name "sj59" --resource-group "sjrg6936"
必要參數
串流作業的名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
請勿等候長時間執行的作業完成。
不提示確認。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stream-analytics job list
列出指定資源群組中的所有串流作業。 並列出指定訂用帳戶中的所有串流作業。
az stream-analytics job list [--expand]
[--resource-group]
範例
列出資源群組中的所有串流作業,而不使用 $expand OData 查詢參數
az stream-analytics job list --resource-group "sjrg6936"
列出資源群組中的所有串流作業,並使用 $expand OData 查詢參數來展開輸入、輸出、轉換和函式
az stream-analytics job list --expand "inputs,outputs,transformation,functions" --resource-group "sjrg3276"
列出訂用帳戶中的所有串流作業,而不使用 $expand OData 查詢參數
az stream-analytics job list
列出訂用帳戶中的所有串流作業,並使用 $expand OData 查詢參數來展開輸入、輸出、轉換和函式
az stream-analytics job list --expand "inputs,outputs,transformation,functions"
選擇性參數
$expand OData 查詢參數。 這是在回應中包含之其他串流作業屬性的逗號分隔清單,超出此參數不存在時所傳回的預設集合。 默認集是 'inputs'、'transformation'、'outputs' 和 'functions' 以外的所有串流作業屬性。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stream-analytics job scale
在作業執行時調整串流作業。
az stream-analytics job scale --job-name
--resource-group
[--no-wait]
[--streaming-units]
範例
調整串流作業
az stream-analytics job scale --job-name "sj59" --resource-group "sjrg6936" --streaming-units 36
必要參數
串流作業的名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
請勿等候長時間執行的作業完成。
指定串流作業將調整為的串流單位數目。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stream-analytics job show
取得指定串流作業的詳細數據。
az stream-analytics job show --job-name
--resource-group
[--expand]
範例
取得串流作業,而不使用 $expand OData 查詢參數
az stream-analytics job show --job-name "sj59" --resource-group "sjrg6936"
取得串流作業,並使用 $expand OData 查詢參數來擴充輸入、輸出、轉換和函式
az stream-analytics job show --expand "inputs,outputs,transformation,functions" --job-name "sj7804" --resource-group "sjrg3276"
必要參數
串流作業的名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
$expand OData 查詢參數。 這是在回應中包含之其他串流作業屬性的逗號分隔清單,超出此參數不存在時所傳回的預設集合。 默認集是 'inputs'、'transformation'、'outputs' 和 'functions' 以外的所有串流作業屬性。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stream-analytics job start
啟動串流作業。 一旦作業啟動,它就會開始處理輸入事件並產生輸出。
az stream-analytics job start --job-name
--resource-group
[--no-wait]
[--output-start-mode {CustomTime, JobStartTime, LastOutputEventTime}]
[--output-start-time]
範例
使用 CustomTime 輸出啟動模式啟動串流作業
az stream-analytics job start --job-name "sj59" --resource-group "sjrg6936" --output-start-mode "CustomTime" --output-start-time "2012-12-12T12:12:12Z"
使用 JobStartTime 輸出啟動模式啟動串流作業
az stream-analytics job start --job-name "sj59" --resource-group "sjrg6936" --output-start-mode "JobStartTime"
使用 LastOutputEventTime 輸出啟動模式啟動串流作業
az stream-analytics job start --job-name "sj59" --resource-group "sjrg6936" --output-start-mode "LastOutputEventTime"
必要參數
串流作業的名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
請勿等候長時間執行的作業完成。
值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指出輸出事件數據流的起點應該在每次啟動作業時啟動、從透過 outputStartTime 屬性指定的自定義用戶時間戳開始,或從最後一個事件輸出時間開始。
值是 ISO-8601 格式化的時間戳,表示輸出事件數據流的起點,或 Null,表示每當串流作業啟動時,輸出事件數據流就會啟動。 如果 outputStartMode 設定為 CustomTime,這個屬性就必須有值。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stream-analytics job stop
停止執行中的串流作業。 這會導致執行中的串流作業停止處理輸入事件並產生輸出。
az stream-analytics job stop --job-name
--resource-group
[--no-wait]
範例
停止串流作業
az stream-analytics job stop --job-name "sj59" --resource-group "sjrg6936"
必要參數
串流作業的名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
請勿等候長時間執行的作業完成。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stream-analytics job update
更新現有的串流作業。 這可以用來部分更新 (即更新一或兩個屬性) 串流作業,而不會影響其餘的作業定義。
az stream-analytics job update --job-name
--resource-group
[--arrival-max-delay]
[--compatibility-level {1.0, 1.2}]
[--content-storage-policy {JobStorageAccount, SystemAccount}]
[--data-locale]
[--functions]
[--id]
[--identity]
[--if-match]
[--inputs]
[--job-storage-account]
[--job-type {Cloud, Edge}]
[--location]
[--order-max-delay]
[--out-of-order-policy {Adjust, Drop}]
[--output-error-policy {Drop, Stop}]
[--output-start-mode {CustomTime, JobStartTime, LastOutputEventTime}]
[--output-start-time]
[--outputs]
[--tags]
[--transformation]
範例
更新串流作業
az stream-analytics job update --job-name "sj59" --resource-group "sjrg6936" --arrival-max-delay 13 --order-max-delay 21
必要參數
串流作業的名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
可容許延遲上限 (以秒為單位),其中可能會包含延遲抵達的事件。 支援的範圍是 -1 到 1814399 (20.23:59:59:59 天)和 -1 用來無限期指定等候。 如果屬性不存在,則會解譯為值為 -1。
控制串流處理工作的某些執行時間行為。
有效值為JobStorageAccount和 SystemAccount。 如果設定為 JobStorageAccount,這需要使用者也指定 jobStorageAccount 屬性。 .
串流分析作業的資料地區設定。 值應該是集合 https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx中支援的 .NET 文化特性名稱。 如果未指定則預設為 'en-US'。
串流作業的一或多個函式清單。 在 PUT 要求中指定此屬性時,需要每個函式的 name 屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別轉換的 PATCH API。 預期值:json-string/json-file/@json-file。
叢集的資源標識碼。
描述指派給此作業的系統指派受控識別,可用來向輸入和輸出進行驗證。
使用量:--identity tenant-id=XX principal-id=XX type=XX
tenant-id:identity tenantId principal-id:身分識別主體標識符類型:身分識別類型。
串流作業的 ETag。 請省略此值,以一律覆寫目前的記錄集。 指定最後看到的 ETag 值,以防止意外覆寫並行變更。
串流作業的一或多個輸入清單。 在 PUT 要求中指定此屬性時,需要每個輸入的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可供個別輸入使用的 PATCH API。 預期值:json-string/json-file/@json-file。
與 MSI Azure 儲存體 帳戶相關聯的屬性。
使用量:--job-storage-account authentication-mode=XX account-name=XX account-key=XX
authentication-mode:驗證模式。 account-name:Azure 儲存體 帳戶的名稱。 PUT (CreateOrReplace) 要求的必要專案。 account-key:Azure 儲存體 帳戶的帳戶密鑰。 PUT (CreateOrReplace) 要求的必要專案。
描述作業的類型。 有效的模式為 Cloud
和 『Edge』。
位置。 值的來源:az account list-locations
。 您可以使用 az configure --defaults location=<location>
設定預設位置。
可容許延遲上限 (以秒為單位),其中可以將順序錯亂的事件調整回原有順序。
指出要套用至輸入事件串流中未按順序送達之事件的原則。
指出要套用至抵達輸出的事件,而且由於格式不正確而無法寫入外部記憶體的原則(遺漏數據行值、類型錯誤或大小的數據行值)。
只有當想要在建立時立即啟動作業時,才應該使用這個屬性。 值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指出輸出事件數據流的起點應該在每次啟動作業時啟動、從透過 outputStartTime 屬性指定的自定義用戶時間戳開始,或從最後一個事件輸出時間開始。
值是 ISO-8601 格式化的時間戳,表示輸出事件數據流的起點,或 Null,表示每當串流作業啟動時,輸出事件數據流就會啟動。 如果 outputStartMode 設定為 CustomTime,這個屬性就必須有值。
串流作業的一或多個輸出清單。 在 PUT 要求中指定此屬性時,需要每個輸出的 name 屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別輸出的 PATCH API。 預期值:json-string/json-file/@json-file。
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。
指出要用於串流作業的查詢和串流單位數目。 在 PUT 要求中指定這個屬性時,需要轉換的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別轉換的 PATCH API。
使用方式:--transformation streaming-units=XX valid-streaming-units=XX query=XX name=XX
串流單位:指定串流作業所使用的串流單位數目。 valid-streaming-units:指定串流作業可調整為的有效串流單位。query:指定將在串流作業中執行的查詢。 您可以在這裏深入瞭解串流分析查詢語言(SAQL: https://msdn.microsoft.com/library/azure/dn834998 )。 PUT (CreateOrReplace) 要求的必要專案。 name:資源名稱。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az stream-analytics job wait
將 CLI 置於等候狀態,直到符合串流分析作業的條件為止。
az stream-analytics job wait --job-name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--expand]
[--interval]
[--timeout]
[--updated]
範例
暫停執行下一行 CLI 腳本,直到成功建立串流分析作業為止。
az stream-analytics job wait --expand "inputs,outputs,transformation,functions" --job-name "sj7804" --resource-group "sjrg3276" --created
暫停執行下一行 CLI 腳本,直到成功刪除串流分析作業為止。
az stream-analytics job wait --expand "inputs,outputs,transformation,functions" --job-name "sj7804" --resource-group "sjrg3276" --deleted
必要參數
串流作業的名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
請等候在 'Succeeded' 使用 'provisioningState' 建立。
等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
等到刪除為止。
等候資源存在。
$expand OData 查詢參數。 這是在回應中包含之其他串流作業屬性的逗號分隔清單,超出此參數不存在時所傳回的預設集合。 默認集是 'inputs'、'transformation'、'outputs' 和 'functions' 以外的所有串流作業屬性。
輪詢間隔以秒為單位。
以秒為單位的等候上限。
等到 provisioningState 更新為 'Succeeded'。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID
設定預設訂用帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。