你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az stream-analytics function

注意

此参考是 Azure CLI（版本 2.15.0 或更高版本）的流分析扩展的一部分。 该扩展将在首次运行 az stream-analytics 函数 命令时自动安装。 详细了解扩展。

使用流分析管理函数。

命令

名称	说明	类型	状态
az stream-analytics function create	创建函数或替换现有流式处理作业下已有的函数。	扩展	GA
az stream-analytics function delete	从流式处理作业中删除函数。	扩展	GA
az stream-analytics function inspect	根据指定的参数检索函数的默认定义。	扩展	GA
az stream-analytics function list	列出指定流式处理作业下的所有函数。	扩展	GA
az stream-analytics function show	获取有关指定函数的详细信息。	扩展	GA
az stream-analytics function test	测试为函数提供的信息是否有效。 这可以包括测试函数后面的基础 Web 服务的连接，或确保提供的函数代码语法正确。	扩展	GA
az stream-analytics function update	更新现有流式处理作业下的现有函数。 这可用于部分更新（即更新一两个属性）函数，而不会影响作业或函数定义的其余部分。	扩展	GA
az stream-analytics function wait	将 CLI 置于等待状态，直到满足流分析函数的条件。	扩展	GA

az stream-analytics function create

创建函数或替换现有流式处理作业下已有的函数。

az stream-analytics function create --function-name
                                    --job-name
                                    --resource-group
                                    [--if-match]
                                    [--if-none-match]
                                    [--properties]

示例

创建 JavaScript 函数

az stream-analytics function create --properties "{\"type\":\"Scalar\",\"properties\":{\"binding\":{\"type\":\"Microsoft.StreamAnalytics/JavascriptUdf\",\"properties\":{\"script\":\"function (x, y) { return x + y; }\"}},\"inputs\":[{\"dataType\":\"Any\"}],\"output\":{\"dataType\":\"Any\"}}}" --function-name "function8197" --job-name "sj8653" --resource-group "sjrg1637"

创建 Azure ML 函数

az stream-analytics function create --properties "{\"type\":\"Scalar\",\"properties\":{\"binding\":{\"type\":\"Microsoft.MachineLearning/WebService\",\"properties\":{\"apiKey\":\"someApiKey==\",\"batchSize\":1000,\"endpoint\":\"someAzureMLEndpointURL\",\"inputs\":{\"name\":\"input1\",\"columnNames\":[{\"name\":\"tweet\",\"dataType\":\"string\",\"mapTo\":0}]},\"outputs\":[{\"name\":\"Sentiment\",\"dataType\":\"string\"}]}},\"inputs\":[{\"dataType\":\"nvarchar(max)\"}],\"output\":{\"dataType\":\"nvarchar(max)\"}}}" --function-name "function588" --job-name "sj9093" --resource-group "sjrg7"

必需参数

--function-name --name -n

函数的名称。

--job-name

流式处理作业的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--if-match

函数的 ETag。 省略此值以始终覆盖当前函数。 指定最后一次看到的 ETag 值，以防止意外覆盖并发更改。

--if-none-match

设置为“*”以允许创建新函数，但要防止更新现有函数。 其他值将导致 412 预条件失败响应。

--properties

与函数关联的属性。 预期值：json-string/json-file/@json-file。

全局参数

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

从流式处理作业中删除函数。

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

示例

删除函数

az stream-analytics function delete --name "function8197" --job-name "sj8653" --resource-group "sjrg1637"

必需参数

--function-name --name -n

函数的名称。

--job-name

流式处理作业的名称。

--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 function inspect

根据指定的参数检索函数的默认定义。

az stream-analytics function inspect --function-name
                                     --job-name
                                     --resource-group
                                     [--ml-properties]

必需参数

--function-name --name -n

函数的名称。

--job-name

流式处理作业的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--ml-properties

检索Azure 机器学习 Web 服务函数的默认函数定义所需的参数。

用法：--ml-properties execute-endpoint=XX

execute-endpoint：Azure 机器学习 Web 服务的 Request-Response 执行终结点。 在此处了解详细信息： https://docs.microsoft.com/en-us/azure/stream-analytics/machine-learning-udf

全局参数

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

列出指定流式处理作业下的所有函数。

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

示例

列出流式处理作业中的所有函数

az stream-analytics function list --job-name "sj8653" --resource-group "sjrg1637"

必需参数

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

获取有关指定函数的详细信息。

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

示例

获取 JavaScript 函数

az stream-analytics function show --name "function8197" --job-name "sj8653" --resource-group "sjrg1637"

获取 Azure ML 函数

az stream-analytics function show --name "function588" --job-name "sj9093" --resource-group "sjrg7"

必需参数

--function-name --name -n

函数的名称。

--job-name

流式处理作业的名称。

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

测试为函数提供的信息是否有效。 这可以包括测试函数后面的基础 Web 服务的连接，或确保提供的函数代码语法正确。

az stream-analytics function test --function-name
                                  --job-name
                                  --resource-group
                                  [--no-wait]
                                  [--properties]

示例

测试 JavaScript 函数的连接

az stream-analytics function test --function-name "function8197" --job-name "sj8653" --resource-group "sjrg1637"

测试 Azure ML 函数的连接

az stream-analytics function test --function-name "function588" --job-name "sj9093" --resource-group "sjrg7"

必需参数

--function-name --name -n

函数的名称。

--job-name

流式处理作业的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--no-wait

不等待长时间运行的操作完成。

默认值: False

--properties

与函数关联的属性。 预期值：json-string/json-file/@json-file。

全局参数

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

更新现有流式处理作业下的现有函数。 这可用于部分更新（即更新一两个属性）函数，而不会影响作业或函数定义的其余部分。

az stream-analytics function update --function-name
                                    --job-name
                                    --resource-group
                                    [--if-match]
                                    [--properties]

示例

更新 JavaScript 函数

az stream-analytics function update --properties "{\"type\":\"Scalar\",\"properties\":{\"binding\":{\"type\":\"Microsoft.StreamAnalytics/JavascriptUdf\",\"properties\":{\"script\":\"function (a, b) { return a * b; }\"}}}}" --function-name "function8197" --job-name "sj8653" --resource-group "sjrg1637"

更新 Azure ML 函数

az stream-analytics function update --properties "{\"type\":\"Scalar\",\"properties\":{\"binding\":{\"type\":\"Microsoft.MachineLearning/WebService\",\"properties\":{\"batchSize\":5000}}}}" --function-name "function588" --job-name "sj9093" --resource-group "sjrg7"

必需参数

--function-name --name -n

函数的名称。

--job-name

流式处理作业的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--if-match

函数的 ETag。 省略此值以始终覆盖当前函数。 指定最后一次看到的 ETag 值，以防止意外覆盖并发更改。

--properties

与函数关联的属性。 预期值：json-string/json-file/@json-file。

全局参数

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

将 CLI 置于等待状态，直到满足流分析函数的条件。

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

示例

暂停执行下一行 CLI 脚本，直到成功创建流分析函数。

az stream-analytics function wait --name "function588" --job-name "sj9093" --resource-group "sjrg7" --created

必需参数

--function-name --name -n

函数的名称。

--job-name

流式处理作业的名称。

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

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。