你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az stream-analytics job
注意
此参考是 Azure CLI(版本 2.15.0 或更高版本)的流分析扩展的一部分。 该扩展将在首次运行 az stream-analytics 作业 命令时自动安装。 详细了解扩展。
使用流分析管理流式处理作业。
命令
名称 | 说明 | 类型 | 状态 |
---|---|---|---|
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"
创建流式处理作业 shell(没有输入、输出、转换或函数的流式处理作业)
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 天),-1 用于指定无限期等待。 如果该属性不存在,则将其解释为具有值 -1。
控制流式处理作业的某些运行时行为。
有效值为 JobStorageAccount 和 SystemAccount。 如果设置为 JobStorageAccount,则这要求用户也指定 jobStorageAccount 属性。 。
流分析作业的数据区域设置。 值应是集中 https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx支持的 .NET 区域性的名称。 如果未指定,则默认为“en-US”。
流式处理作业的一个或多个函数的列表。 在 PUT 请求中指定此属性时,需要每个函数的名称属性。 此属性不能通过 PATCH 操作进行修改。 必须使用可用于单个转换的 PATCH API。 预期值:json-string/json-file/@json-file。
群集的资源 ID。
描述分配给此作业的系统分配的托管标识,该标识可用于通过输入和输出进行身份验证。
用法:--identity tenant-id=XX principal-id=XX type=XX
tenant-id:identity tenantId principal-id:标识主体 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 请求中指定此属性时,需要每个输出的名称属性。 此属性不能通过 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) 请求时是必需的。 名称:资源名称。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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/。
订阅的名称或 ID。 可以使用 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/。
订阅的名称或 ID。 可以使用 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/。
订阅的名称或 ID。 可以使用 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/。
订阅的名称或 ID。 可以使用 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/。
订阅的名称或 ID。 可以使用 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/。
订阅的名称或 ID。 可以使用 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 天),-1 用于指定无限期等待。 如果该属性不存在,则将其解释为具有值 -1。
控制流式处理作业的某些运行时行为。
有效值为 JobStorageAccount 和 SystemAccount。 如果设置为 JobStorageAccount,则这要求用户也指定 jobStorageAccount 属性。 。
流分析作业的数据区域设置。 值应是集中 https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx支持的 .NET 区域性的名称。 如果未指定,则默认为“en-US”。
流式处理作业的一个或多个函数的列表。 在 PUT 请求中指定此属性时,需要每个函数的名称属性。 此属性不能通过 PATCH 操作进行修改。 必须使用可用于单个转换的 PATCH API。 预期值:json-string/json-file/@json-file。
群集的资源 ID。
描述分配给此作业的系统分配的托管标识,该标识可用于通过输入和输出进行身份验证。
用法:--identity tenant-id=XX principal-id=XX type=XX
tenant-id:identity tenantId principal-id:标识主体 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 请求中指定此属性时,需要每个输出的名称属性。 此属性不能通过 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) 请求时是必需的。 名称:资源名称。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 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/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。