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

az stream-analytics output

注意

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

使用流分析管理输出。

命令

名称	说明	类型	状态
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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

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

--verbose

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