az stream-analytics job

注意

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

使用串流分析管理串流作業。

命令

az stream-analytics job create

建立串流作業,或取代已經存在的串流作業。

az stream-analytics job delete

刪除串流作業。

az stream-analytics job list

列出指定資源群組中的所有串流作業。 和 列出指定訂用帳戶中的所有串流作業。

az stream-analytics job scale

當作業正在執行時,調整串流作業。

az stream-analytics job show

取得指定串流作業的詳細資料。

az stream-analytics job start

啟動串流作業。 一旦啟動作業,它就會開始處理輸入事件並產生輸出。

az stream-analytics job stop

停止執行中的串流作業。 這會導致執行中的串流作業停止處理輸入事件並產生輸出。

az stream-analytics job update

更新現有的串流作業。 這可用來部分更新 (ie。更新串流作業) 一或兩個屬性,而不會影響其餘工作定義。

az stream-analytics job wait

將 CLI 置於等候狀態,直到符合串流分析作業的條件為止。

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"

必要參數

--job-name --name -n

串流作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--arrival-max-delay

可容許延遲上限 (以秒為單位),其中可能會包含延遲抵達的事件。 支援的範圍從 -1 到 1814399 (20.23:59:59 天),而 -1 適用來指定無限期等候。 如果屬性不存在,則會解譯為具有值 -1。

--compatibility-level

控制串流處理工作的某些執行時間行為。

接受的值: 1.0, 1.2
--content-storage-policy

有效值為 JobStorageAccount 和 SystemAccount。 如果設定為 JobStorageAccount,這需要使用者同時指定 jobStorageAccount 屬性。 .

接受的值: JobStorageAccount, SystemAccount
--data-locale

串流分析作業的資料地區設定。 值應該是集合 https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx 中支援的 .NET 文化特性名稱。 如果未指定則預設為 'en-US'。

--functions

串流作業的一或多個函式清單。 在 PUT 要求中指定此屬性時,需要每個函式的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別轉換的 PATCH API。 預期值:json-string/json-file/@json-file。

--id

叢集的資源識別碼。

--identity

描述指派給此作業的系統指派受控識別,可用來向輸入和輸出進行驗證。

--if-match

串流作業的 ETag。 省略此值以一律覆寫目前的記錄集。 指定最後一個出現的 ETag 值,以防止意外覆寫並行變更。

--if-none-match

設定為 '*' 以允許建立新的串流作業,但為了避免更新現有的記錄集。 其他值會導致 412 預先條件失敗的回應。

--inputs

串流作業的一或多個輸入清單。 在 PUT 要求中指定此屬性時,需要每個輸入的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別輸入的 PATCH API。 預期值:json-string/json-file/@json-file。

--job-storage-account

與具有 MSI 的 Azure 儲存體帳戶相關聯的屬性。

--job-type

描述作業的類型。 有效的模式為 Cloud 和 'Edge'。

接受的值: Cloud, Edge
--location -l

位置。 值的來源:az account list-locations。 您可以使用 az configure --defaults location=<location> 來設定預設位置。

--no-wait

不等候長時間執行的作業完成。

--order-max-delay

可容許延遲上限 (以秒為單位),其中可以將順序錯亂的事件調整回原有順序。

--out-of-order-policy

指出要套用至輸入事件串流中未按順序送達之事件的原則。

接受的值: Adjust, Drop
--output-error-policy

指出要套用至到達輸出且因格式錯誤 (遺失資料行值、資料行值的類型或大小錯誤) 而無法寫入外部儲存體之事件的原則。

接受的值: Drop, Stop
--output-start-mode

只有在建立作業時立即啟動作業時,才應該使用這個屬性。 值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指出每當啟動作業時,輸出事件資料流程的起點應該啟動、從透過 outputStartTime 屬性指定的自訂使用者時間戳記開始,或從最後一個事件輸出時間開始。

接受的值: CustomTime, JobStartTime, LastOutputEventTime
--output-start-time

值可以是 ISO 8601 格式的時間戳記 (代表輸出事件資料流的啟動點) 或 null (代表輸出事件資料流會在每次資料流工作啟動時啟動)。 如果 outputStartMode 設定為 CustomTime,此屬性必須有值。

--outputs

串流作業的一或多個輸出清單。 在 PUT 要求中指定此屬性時,需要每個輸出的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別輸出的 PATCH API。 預期值:json-string/json-file/@json-file。

--tags

空格分隔標記:key[=value] [key[=value] ...]。使用 「」 清除現有的標籤。

--transformation

指出要用於串流作業的查詢和串流單位數目。 在 PUT 要求中指定此屬性時,需要轉換的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別轉換的 PATCH API。

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"

必要參數

--job-name --name -n

串流作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--no-wait

不等候長時間執行的作業完成。

--yes -y

不提示確認。

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

$expand OData 查詢參數。 這是其他串流作業屬性的逗號分隔清單,可包含在回應中,超出此參數不存在時傳回的預設集合。 預設集是 'inputs'、'transformation'、'outputs' 和 'functions' 以外的所有串流作業屬性。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

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

必要參數

--job-name --name -n

串流作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--no-wait

不等候長時間執行的作業完成。

--streaming-units

指定串流作業將調整為的串流單位數目。

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"

必要參數

--job-name --name -n

串流作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--expand

$expand OData 查詢參數。 這是其他串流作業屬性的逗號分隔清單,可包含在回應中,超出此參數不存在時傳回的預設集合。 預設集是 'inputs'、'transformation'、'outputs' 和 'functions' 以外的所有串流作業屬性。

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"

必要參數

--job-name --name -n

串流作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--no-wait

不等候長時間執行的作業完成。

--output-start-mode

值可能是 JobStartTime、CustomTime 或 LastOutputEventTime,以指出每次啟動作業時輸出事件資料流程的起點、從透過 outputStartTime 屬性指定的自訂使用者時間戳記開始,或從上次事件輸出時間開始。

接受的值: CustomTime, JobStartTime, LastOutputEventTime
--output-start-time

值可以是 ISO 8601 格式的時間戳記 (代表輸出事件資料流的啟動點) 或 null (代表輸出事件資料流會在每次資料流工作啟動時啟動)。 如果 outputStartMode 設定為 CustomTime,這個屬性必須有值。

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"

必要參數

--job-name --name -n

串流作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--no-wait

不等候長時間執行的作業完成。

az stream-analytics job update

更新現有的串流作業。 這可用來部分更新 (ie。更新串流作業) 一或兩個屬性,而不會影響其餘工作定義。

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

必要參數

--job-name --name -n

串流作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--arrival-max-delay

可容許延遲上限 (以秒為單位),其中可能會包含延遲抵達的事件。 支援的範圍從 -1 到 1814399 (20.23:59:59 天),而 -1 適用來指定無限期等候。 如果屬性不存在,則會解譯為具有值 -1。

--compatibility-level

控制串流處理工作的某些執行時間行為。

接受的值: 1.0, 1.2
--content-storage-policy

有效值為 JobStorageAccount 和 SystemAccount。 如果設定為 JobStorageAccount,這需要使用者同時指定 jobStorageAccount 屬性。 .

接受的值: JobStorageAccount, SystemAccount
--data-locale

串流分析作業的資料地區設定。 值應該是集合 https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx 中支援的 .NET 文化特性名稱。 如果未指定則預設為 'en-US'。

--functions

串流作業的一或多個函式清單。 在 PUT 要求中指定此屬性時,需要每個函式的名稱屬性。 這個屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別轉換的 PATCH API。 預期值:json-string/json-file/@json-file。

--id

叢集的資源識別碼。

--identity

描述指派給此作業的系統指派受控識別,可用來向輸入和輸出進行驗證。

--if-match

串流作業的 ETag。 請省略此值以一律覆寫目前的記錄集。 指定上次出現的 ETag 值,以防止意外覆寫並行變更。

--inputs

串流作業的一或多個輸入清單。 在 PUT 要求中指定此屬性時,需要每個輸入的名稱屬性。 這個屬性無法透過 PATCH 作業進行修改。 您必須使用可供個別輸入使用的 PATCH API。 預期值:json-string/json-file/@json-file。

--job-storage-account

與具有 MSI 的 Azure 儲存體帳戶相關聯的屬性。

--job-type

描述作業的類型。 有效的模式為 Cloud 和 'Edge'。

接受的值: Cloud, Edge
--location -l

位置。 值的來源:az account list-locations。 您可以使用 az configure --defaults location=<location> 來設定預設位置。

--order-max-delay

可容許延遲上限 (以秒為單位),其中可以將順序錯亂的事件調整回原有順序。

--out-of-order-policy

指出要套用至輸入事件串流中未按順序送達之事件的原則。

接受的值: Adjust, Drop
--output-error-policy

指出要套用至到達輸出且因格式錯誤 (遺失資料行值、資料行值的類型或大小錯誤) 而無法寫入外部儲存體之事件的原則。

接受的值: Drop, Stop
--output-start-mode

只有在想要在建立時立即啟動作業時,才應該使用這個屬性。 值可能是 JobStartTime、CustomTime 或 LastOutputEventTime,以指出每次啟動作業時輸出事件資料流程的起點、從透過 outputStartTime 屬性指定的自訂使用者時間戳記開始,或從上次事件輸出時間開始。

接受的值: CustomTime, JobStartTime, LastOutputEventTime
--output-start-time

值可以是 ISO 8601 格式的時間戳記 (代表輸出事件資料流的啟動點) 或 null (代表輸出事件資料流會在每次資料流工作啟動時啟動)。 如果 outputStartMode 設定為 CustomTime,這個屬性必須有值。

--outputs

串流作業的一或多個輸出清單。 在 PUT 要求中指定此屬性時,需要每個輸出的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別輸出的 PATCH API。 預期值:json-string/json-file/@json-file。

--tags

空格分隔標記:key[=value] [key[=value] ...]。使用 「」 清除現有的標籤。

--transformation

指出要用於串流作業的查詢和串流單位數目。 在 PUT 要求中指定此屬性時,需要轉換的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別轉換的 PATCH API。

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

必要參數

--job-name --name -n

串流作業的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--created

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

--custom

等到條件符合自訂 JMESPath 查詢為止。 例如 provisioningState!='InProgress',instanceView.statuses[?code=='PowerState/running']。

--deleted

等到刪除為止。

--exists

等到資源存在為止。

--expand

$expand OData 查詢參數。 這是其他串流作業屬性的逗號分隔清單,可包含在回應中,超出此參數不存在時所傳回的預設集合。 預設集是 'inputs'、'transformation'、'outputs' 和 'functions' 以外的所有串流作業屬性。

--interval

以秒為單位輪詢間隔。

預設值: 30
--timeout

等候時間上限,以秒為單位。

預設值: 3600
--updated

等候 provisioningState 更新為 'Succeeded'。