你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Streaming Jobs - Create Or Replace
创建流式处理作业或替换现有的流式处理作业。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}?api-version=2020-03-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
job
|
path | True |
string |
流式处理作业的名称。 |
resource
|
path | True |
string |
资源组的名称。 此名称不区分大小写。 正则表达式模式: |
subscription
|
path | True |
string |
目标订阅的 ID。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
If-Match |
string |
流式处理作业的 ETag。 省略此值以始终覆盖当前记录集。 指定上次看到的 ETag 值,以防止意外覆盖并发更改。 |
|
If-None-Match |
string |
设置为“*”以允许创建新的流式处理作业,但会阻止更新现有记录集。 其他值将导致 412 先决条件失败响应。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
identity |
介绍分配给此作业的系统分配托管标识,该标识可用于通过输入和输出进行身份验证。 |
|
location |
string |
资源所在的地理位置 |
properties.cluster |
将运行流式处理作业的群集。 |
|
properties.compatibilityLevel |
控制流式处理作业的某些运行时行为。 |
|
properties.contentStoragePolicy |
有效值为 JobStorageAccount 和 SystemAccount。 如果设置为 JobStorageAccount,则要求用户同时指定 jobStorageAccount 属性。 . |
|
properties.dataLocale |
string |
流分析作业的数据区域设置。 值应为集 https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx中支持的 .NET 区域性的名称。 如果未指定,则默认为“en-US”。 |
properties.eventsLateArrivalMaxDelayInSeconds |
integer |
可容忍的最大延迟(以秒为单位),其中可能包括迟到事件。 支持的范围为 -1 到 1814399(20.23:59:59 天),-1 用于指定无限期等待。 如果该属性不存在,则将其解释为具有值 -1。 |
properties.eventsOutOfOrderMaxDelayInSeconds |
integer |
可容许的最大延迟(以秒为单位),其中无序事件可重新调整为有序事件。 |
properties.eventsOutOfOrderPolicy |
指示要应用于输入事件流中未按顺序到达的事件的策略。 |
|
properties.functions |
Function[] |
流式处理作业的一个或多个函数的列表。 在 PUT 请求中指定此属性时,需要每个函数的 name 属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个转换的 PATCH API。 |
properties.inputs |
Input[] |
流式处理作业的一个或多个输入的列表。 在 PUT 请求中指定此属性时,每个输入的名称属性是必需的。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个输入的 PATCH API。 |
properties.jobStorageAccount |
与具有 MSI 的 Azure 存储帐户关联的属性 |
|
properties.jobType |
描述作业的类型。 有效模式为 |
|
properties.outputErrorPolicy |
指示要应用于到达输出但由于格式错误(缺少列值、列值类型或大小错误)而无法写入外部存储的事件的策略。 |
|
properties.outputStartMode |
仅当需要作业在创建时立即启动时才应使用此属性。 值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指示输出事件流的起点应在作业每次启动时启动、从通过 outputStartTime 属性指定的自定义用户时间戳开始,还是从上次事件输出时间开始。 |
|
properties.outputStartTime |
string |
值为采用 ISO-8601 格式的时间戳(指示输出事件流的起点),或者为 null(指示输出事件流将在每次启动流式处理作业时开始)。 如果 outputStartMode 设置为 CustomTime,则此属性必须具有值。 |
properties.outputs |
Output[] |
流式处理作业的一个或多个输出的列表。 在 PUT 请求中指定此属性时,需要每个输出的 name 属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个输出的 PATCH API。 |
properties.sku |
描述流式处理作业的 SKU。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
properties.transformation |
指示用于流式处理作业的查询和流单元数。 在 PUT 请求中指定此属性时,需要转换的 name 属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个转换的 PATCH API。 |
|
tags |
object |
资源标记。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
已成功创建或替换流式处理作业。 标头 ETag: string |
|
201 Created |
已成功创建或替换流式处理作业。 标头 ETag: string |
|
Other Status Codes |
错误。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Create a complete streaming job (a streaming job with a transformation, at least 1 input and at least 1 output)
示例请求
PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804?api-version=2020-03-01
{
"properties": {
"sku": {
"name": "Standard"
},
"eventsOutOfOrderPolicy": "Drop",
"outputErrorPolicy": "Drop",
"eventsOutOfOrderMaxDelayInSeconds": 0,
"eventsLateArrivalMaxDelayInSeconds": 5,
"dataLocale": "en-US",
"compatibilityLevel": "1.0",
"inputs": [
{
"properties": {
"type": "Stream",
"datasource": {
"type": "Microsoft.Storage/Blob",
"properties": {
"storageAccounts": [
{
"accountName": "yourAccountName",
"accountKey": "yourAccountKey=="
}
],
"container": "containerName",
"pathPattern": ""
}
},
"serialization": {
"type": "Json",
"properties": {
"encoding": "UTF8"
}
}
},
"name": "inputtest"
}
],
"transformation": {
"properties": {
"streamingUnits": 1,
"query": "Select Id, Name from inputtest"
},
"name": "transformationtest"
},
"outputs": [
{
"properties": {
"datasource": {
"type": "Microsoft.Sql/Server/Database",
"properties": {
"server": "serverName",
"database": "databaseName",
"user": "<user>",
"password": "userPassword",
"table": "tableName"
}
}
},
"name": "outputtest"
}
],
"functions": []
},
"location": "West US",
"tags": {
"key1": "value1",
"randomKey": "randomValue",
"key3": "value3"
}
}
示例响应
ETag: 87551cc5-1290-4d08-afcd-cdaa92e5ade0
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804",
"name": "sj7804",
"type": "Microsoft.StreamAnalytics/streamingjobs",
"location": "West US",
"tags": {
"key1": "value1",
"randomKey": "randomValue",
"key3": "value3"
},
"properties": {
"sku": {
"name": "Standard"
},
"jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9",
"provisioningState": "Succeeded",
"jobState": "Created",
"eventsOutOfOrderPolicy": "Drop",
"outputErrorPolicy": "Drop",
"eventsOutOfOrderMaxDelayInSeconds": 0,
"eventsLateArrivalMaxDelayInSeconds": 5,
"dataLocale": "en-US",
"createdDate": "2017-05-11T04:37:11.54Z",
"compatibilityLevel": "1.0",
"inputs": [
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest",
"name": "inputtest",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Stream",
"datasource": {
"type": "Microsoft.Storage/Blob",
"properties": {
"storageAccounts": [
{
"accountName": "accountName"
}
],
"container": "containerName",
"pathPattern": ""
}
},
"serialization": {
"type": "Json",
"properties": {
"encoding": "UTF8"
}
},
"etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0"
}
}
],
"transformation": {
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest",
"name": "transformationtest",
"type": "Microsoft.StreamAnalytics/streamingjobs/transformations",
"properties": {
"streamingUnits": 1,
"query": "Select Id, Name from inputtest",
"etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8"
}
},
"functions": [],
"outputs": [
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest",
"name": "outputtest",
"type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
"properties": {
"datasource": {
"type": "Microsoft.Sql/Server/Database",
"properties": {
"server": "serverName",
"database": "databaseName",
"table": "tableName",
"user": "userName"
}
},
"etag": "62097c3c-b503-41ff-a56f-196a9598ab90"
}
}
]
}
}
ETag: 87551cc5-1290-4d08-afcd-cdaa92e5ade0
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804",
"name": "sj7804",
"type": "Microsoft.StreamAnalytics/streamingjobs",
"location": "West US",
"tags": {
"key1": "value1",
"randomKey": "randomValue",
"key3": "value3"
},
"properties": {
"sku": {
"name": "Standard"
},
"jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9",
"provisioningState": "Succeeded",
"jobState": "Created",
"eventsOutOfOrderPolicy": "Drop",
"outputErrorPolicy": "Drop",
"eventsOutOfOrderMaxDelayInSeconds": 0,
"eventsLateArrivalMaxDelayInSeconds": 5,
"dataLocale": "en-US",
"createdDate": "2017-05-11T04:37:11.54Z",
"compatibilityLevel": "1.0",
"inputs": [
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest",
"name": "inputtest",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Stream",
"datasource": {
"type": "Microsoft.Storage/Blob",
"properties": {
"storageAccounts": [
{
"accountName": "accountName"
}
],
"container": "containerName",
"pathPattern": ""
}
},
"serialization": {
"type": "Json",
"properties": {
"encoding": "UTF8"
}
},
"etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0"
}
}
],
"transformation": {
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest",
"name": "transformationtest",
"type": "Microsoft.StreamAnalytics/streamingjobs/transformations",
"properties": {
"streamingUnits": 1,
"query": "Select Id, Name from inputtest",
"etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8"
}
},
"functions": [],
"outputs": [
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest",
"name": "outputtest",
"type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
"properties": {
"datasource": {
"type": "Microsoft.Sql/Server/Database",
"properties": {
"server": "serverName",
"database": "databaseName",
"table": "tableName",
"user": "userName"
}
},
"etag": "62097c3c-b503-41ff-a56f-196a9598ab90"
}
}
]
}
}
Create a streaming job shell (a streaming job with no inputs, outputs, transformation, or functions)
示例请求
PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59?api-version=2020-03-01
{
"properties": {
"sku": {
"name": "Standard"
},
"eventsOutOfOrderPolicy": "Drop",
"outputErrorPolicy": "Drop",
"eventsOutOfOrderMaxDelayInSeconds": 5,
"eventsLateArrivalMaxDelayInSeconds": 16,
"dataLocale": "en-US",
"compatibilityLevel": "1.0",
"inputs": [],
"outputs": [],
"functions": []
},
"location": "West US",
"tags": {
"key1": "value1",
"randomKey": "randomValue",
"key3": "value3"
}
}
示例响应
ETag: 3e6872bc-c9d0-45b6-91b6-da66f1773056
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59",
"name": "sj59",
"type": "Microsoft.StreamAnalytics/streamingjobs",
"location": "West US",
"tags": {
"key1": "value1",
"randomKey": "randomValue",
"key3": "value3"
},
"properties": {
"sku": {
"name": "Standard"
},
"jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061",
"provisioningState": "Succeeded",
"jobState": "Created",
"eventsOutOfOrderPolicy": "Drop",
"outputErrorPolicy": "Drop",
"eventsOutOfOrderMaxDelayInSeconds": 5,
"eventsLateArrivalMaxDelayInSeconds": 16,
"dataLocale": "en-US",
"createdDate": "2017-05-11T04:37:04.697Z",
"compatibilityLevel": "1.0",
"inputs": [],
"functions": [],
"outputs": []
}
}
ETag: 3e6872bc-c9d0-45b6-91b6-da66f1773056
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59",
"name": "sj59",
"type": "Microsoft.StreamAnalytics/streamingjobs",
"location": "West US",
"tags": {
"key1": "value1",
"randomKey": "randomValue",
"key3": "value3"
},
"properties": {
"sku": {
"name": "Standard"
},
"jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061",
"provisioningState": "Succeeded",
"jobState": "Created",
"eventsOutOfOrderPolicy": "Drop",
"outputErrorPolicy": "Drop",
"eventsOutOfOrderMaxDelayInSeconds": 5,
"eventsLateArrivalMaxDelayInSeconds": 16,
"dataLocale": "en-US",
"createdDate": "2017-05-11T04:37:04.697Z",
"compatibilityLevel": "1.0",
"inputs": [],
"functions": [],
"outputs": []
}
}
定义
名称 | 说明 |
---|---|
Aggregate |
与聚合函数关联的属性。 |
Authentication |
身份验证模式。 有效模式为 |
Avro |
描述如何序列化输入中的数据,或者在以 Avro 格式写入输出时如何序列化数据。 |
Azure |
介绍 Azure Data Lake Store 输出数据源。 |
Azure |
定义 AzureFunctionOutputDataSource 的元数据 |
Azure |
绑定到 Azure 机器学习 Web 服务。 |
Azure |
介绍 Azure 机器学习 Web 服务终结点的输入列。 |
Azure |
Azure 机器学习 Web 服务终结点的输入。 |
Azure |
介绍 Azure 机器学习 Web 服务终结点的输出列。 |
Azure |
描述Azure SQL数据库输出数据源。 |
Azure |
介绍Azure SQL数据库引用输入数据源。 |
Azure |
描述Azure Synapse输出数据源。 |
Azure |
描述 Azure 表输出数据源。 |
Blob |
描述 Blob 输出数据源。 |
Blob |
描述包含引用数据的 Blob 输入数据源。 |
Blob |
描述包含流数据的 Blob 输入数据源。 |
Cluster |
与流分析群集关联的属性。 |
Compatibility |
控制流式处理作业的某些运行时行为。 |
Compression |
介绍如何压缩输入数据 |
Compression |
指示输入使用的压缩类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
Content |
有效值为 JobStorageAccount 和 SystemAccount。 如果设置为 JobStorageAccount,则这要求用户同时指定 jobStorageAccount 属性。 . |
Csv |
描述如何序列化输入中的数据,或者在以 CSV 格式写入输出时如何序列化数据。 |
Diagnostic |
适用于资源或整体作业的条件,值得客户关注。 |
Diagnostics |
描述适用于输入、输出或整体作业的条件,这些条件值得客户关注。 |
Document |
描述 DocumentDB 输出数据源。 |
Encoding |
指定输入时传入数据的编码,在输出的情况下指定传出数据的编码。 |
Error |
常见错误表示形式。 |
Event |
描述事件中心输出数据源。 |
Event |
描述包含流数据的事件中心输入数据源。 |
Event |
描述事件中心输出数据源。 |
Event |
描述包含流数据的事件中心输入数据源。 |
Event |
指示输入或输出使用的序列化类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
Events |
指示要应用于输入事件流中未按顺序到达的事件的策略。 |
File |
描述包含引用数据的文件输入数据源。 |
Function |
一个函数对象,包含与命名函数关联的所有信息。 所有函数都包含在流式处理作业下。 |
Function |
描述函数的一个输入参数。 |
Function |
描述函数的输出。 |
Gateway |
介绍网关消息总线输出数据源。 |
Gateway |
描述包含流数据的 Blob 输入数据源。 |
Identity |
描述如何验证标识 |
Input |
一个输入对象,包含与命名输入关联的所有信息。 所有输入都包含在流式处理作业下。 |
Io |
描述包含流数据的IoT 中心输入数据源。 |
Java |
绑定到 JavaScript 函数。 |
Job |
与具有 MSI 的 Azure 存储帐户关联的属性 |
Job |
描述作业的类型。 有效模式为 |
Json |
指定将写入输出的 JSON 的格式。 当前支持的值是“lineSeparated”,指示输出的格式将由新行分隔,“array”指示输出将格式化为 JSON 对象的数组。 |
Json |
描述如何序列化输入中的数据,或者在以 JSON 格式写入输出时如何序列化数据。 |
Output |
一个输出对象,包含与命名输出关联的所有信息。 所有输出都包含在流式处理作业下。 |
Output |
指示要应用于到达输出但由于格式错误(缺少列值、列值类型或大小错误)而无法写入外部存储的事件的策略。 |
Output |
值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指示输出事件流的起点应每当作业启动时启动、从通过 outputStartTime 属性指定的自定义用户时间戳开始,还是从上次事件输出时间开始。 |
Parquet |
描述如何序列化输入中的数据,或者在以 Parquet 格式写入输出时如何序列化数据。 |
Power |
介绍 Power BI 输出数据源。 |
Reference |
与包含引用数据的输入关联的属性。 |
Refresh |
指示数据刷新选项的类型。 |
Scalar |
与标量函数关联的属性。 |
Service |
描述服务总线队列输出数据源。 |
Service |
描述服务总线主题输出数据源。 |
Sku |
与 SKU 关联的属性。 |
Sku |
SKU 的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
Storage |
与 Azure 存储帐户关联的属性 |
Streaming |
一个流式处理作业对象,包含与命名流式处理作业关联的所有信息。 |
Stream |
与包含流数据的输入关联的属性。 |
Transformation |
一个转换对象,包含与命名转换关联的所有信息。 所有转换都包含在流式处理作业下。 |
AggregateFunctionProperties
与聚合函数关联的属性。
名称 | 类型 | 说明 |
---|---|---|
etag |
string |
函数的当前实体标记。 这是一个不透明的字符串。 可以使用它来检测资源是否在请求之间发生了更改。 还可以在 If-Match 或 If-None-Match 标头中使用它进行写入操作,实现乐观并发。 |
properties.binding | FunctionBinding: |
函数的物理绑定。 例如,在 Azure 机器学习 Web 服务的情况下,它描述了终结点。 |
properties.inputs |
描述函数的一个输入参数。 |
|
properties.output |
描述函数的输出。 |
|
type |
string:
Aggregate |
指示函数的类型。 |
AuthenticationMode
身份验证模式。 有效模式为 ConnectionString
、 Msi
和 “UserToken”。
名称 | 类型 | 说明 |
---|---|---|
ConnectionString |
string |
|
Msi |
string |
|
UserToken |
string |
AvroSerialization
描述如何序列化输入中的数据,或者在以 Avro 格式写入输出时如何序列化数据。
名称 | 类型 | 说明 |
---|---|---|
type |
string:
Avro |
指示输入或输出使用的序列化类型。 在 PUT (CreateOrReplace) 请求上是必需的。 |
AzureDataLakeStoreOutputDataSource
介绍 Azure Data Lake Store 输出数据源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
properties.accountName |
string |
Azure Data Lake Store 帐户的名称。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
properties.authenticationMode | ConnectionString |
身份验证模式。 |
|
properties.dateFormat |
string |
日期格式。 无论 {date} 出现在 filePathPrefix 中,此属性的值都改为用作日期格式。 |
|
properties.filePathPrefix |
string |
输出应写入到的文件的位置。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
properties.refreshToken |
string |
一个刷新令牌,可用于获取有效的访问令牌,然后可用于对数据源进行身份验证。 有效的刷新令牌目前只能通过 Azure 门户获取。 建议在创建数据源时在此处放置一个虚拟字符串值,然后转到 Azure 门户对数据源进行身份验证,该数据源将使用有效的刷新令牌更新此属性。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
properties.tenantId |
string |
用于获取刷新令牌的用户的租户 ID。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
properties.timeFormat |
string |
时间格式。 无论 {time} 出现在 filePathPrefix 中的位置,此属性的值都改为用作时间格式。 |
|
properties.tokenUserDisplayName |
string |
用于获取刷新令牌的用户的用户显示名称。 使用此属性可帮助记住使用哪个用户获取刷新令牌。 |
|
properties.tokenUserPrincipalName |
string |
用户主体名称 (用于获取刷新令牌的用户的 UPN) 。 使用此属性可帮助记住使用哪个用户获取刷新令牌。 |
|
type |
string:
Microsoft. |
指示将写入数据源输出的类型。 在 PUT (CreateOrReplace) 请求上是必需的。 |
AzureFunctionOutputDataSource
定义 AzureFunctionOutputDataSource 的元数据
名称 | 类型 | 说明 |
---|---|---|
properties.apiKey |
string |
若要使用其他订阅中的 Azure 函数,可提供用于访问该函数的密钥。 |
properties.functionAppName |
string |
Azure Functions 应用的名称。 |
properties.functionName |
string |
Azure Functions 应用中的函数的名称。 |
properties.maxBatchCount |
number |
一个用于指定发送到 Azure Functions 的每个批中的最大事件数的属性。 默认值为 100。 |
properties.maxBatchSize |
number |
此属性可用于设置将发送到 Azure 函数的每个输出批的最大大小。 输入单元以字节为单位。 默认情况下,此值为 262,144 字节 (256 KB)。 |
type |
string:
Microsoft. |
指示将写入数据源输出的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
AzureMachineLearningWebServiceFunctionBinding
绑定到 Azure 机器学习 Web 服务。
名称 | 类型 | 说明 |
---|---|---|
properties.apiKey |
string |
用于对 Request-Response 终结点进行身份验证的 API 密钥。 |
properties.batchSize |
integer |
数字介于 1 和 10000 之间,描述每个 Azure ML RRS 执行请求的最大行数。 默认值为 1000。 |
properties.endpoint |
string |
Request-Response 执行 Azure 机器学习 Web 服务的终结点。 在此处了解详细信息: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs |
properties.inputs |
Azure 机器学习 Web 服务终结点的输入。 |
|
properties.outputs |
Azure 机器学习 Web 服务终结点执行的输出列表。 |
|
type |
string:
Microsoft. |
指示函数绑定类型。 |
AzureMachineLearningWebServiceInputColumn
介绍 Azure 机器学习 Web 服务终结点的输入列。
名称 | 类型 | 说明 |
---|---|---|
dataType |
string |
Azure 机器学习支持的 () 输入列的数据类型。 有关有效 Azure 机器学习数据类型的列表,请参阅 https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx 。 |
mapTo |
integer |
此输入映射到的函数参数的从零开始的索引。 |
name |
string |
输入列的名称。 |
AzureMachineLearningWebServiceInputs
Azure 机器学习 Web 服务终结点的输入。
名称 | 类型 | 说明 |
---|---|---|
columnNames |
Azure 机器学习 Web 服务终结点的输入列列表。 |
|
name |
string |
输入的名称。 这是创作终结点时提供的名称。 |
AzureMachineLearningWebServiceOutputColumn
介绍 Azure 机器学习 Web 服务终结点的输出列。
名称 | 类型 | 说明 |
---|---|---|
dataType |
string |
Azure 机器学习支持的 () 输出列的数据类型。 有关有效 Azure 机器学习数据类型的列表,请参阅 https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx 。 |
name |
string |
输出列的名称。 |
AzureSqlDatabaseOutputDataSource
描述Azure SQL数据库输出数据源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
properties.authenticationMode | ConnectionString |
身份验证模式。 |
|
properties.database |
string |
Azure SQL数据库的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.maxBatchCount |
number |
写入 Sql 数据库的最大批处理计数,默认值为 10,000。 在 PUT 请求上是可选的。 |
|
properties.maxWriterCount |
number |
最大编写器计数,目前只有 1 个 (个编写器) 和 0 个基于查询分区) 的 (可用。 在 PUT 请求上是可选的。 |
|
properties.password |
string |
将用于连接到 Azure SQL 数据库的密码。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.server |
string |
包含 Azure SQL 数据库的 SQL 服务器的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.table |
string |
Azure SQL 数据库中表的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.user |
string |
将用于连接到Azure SQL数据库的用户名。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
type |
string:
Microsoft. |
指示将写入数据源输出的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
AzureSqlReferenceInputDataSource
介绍Azure SQL数据库引用输入数据源。
名称 | 类型 | 说明 |
---|---|---|
properties.database |
string |
此元素与 datasource 元素相关联。 这是要将输出写入到的数据库的名称。 |
properties.deltaSnapshotQuery |
string |
此元素与 datasource 元素相关联。 此查询用于从 SQL 数据库提取增量更改。 若要使用此选项,建议在 Azure SQL 数据库中使用临时表。 |
properties.fullSnapshotQuery |
string |
此元素与 datasource 元素相关联。 此查询用于从 sql 数据库提取数据。 |
properties.password |
string |
此元素与 datasource 元素相关联。 这是用于连接 SQL Database 实例的密码。 |
properties.refreshRate |
string |
此元素与 datasource 元素相关联。 这表示从数据库提取数据的频率。 它是 DateTime 格式。 |
properties.refreshType |
指示数据刷新选项的类型。 |
|
properties.server |
string |
此元素与 datasource 元素相关联。 这是要写入到的数据库所在的服务器的名称。 |
properties.table |
string |
此元素与 datasource 元素相关联。 Azure SQL数据库中表的名称。 |
properties.user |
string |
此元素与 datasource 元素相关联。 这是用于连接 SQL Database 实例的用户名。 |
type |
string:
Microsoft. |
指示包含引用数据的输入数据源的类型。 在 PUT (CreateOrReplace) 请求上是必需的。 |
AzureSynapseOutputDataSource
描述Azure Synapse输出数据源。
名称 | 类型 | 说明 |
---|---|---|
properties.database |
string |
Azure SQL数据库的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.password |
string |
将用于连接到 Azure SQL 数据库的密码。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.server |
string |
包含 Azure SQL 数据库的 SQL 服务器的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.table |
string |
Azure SQL 数据库中表的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.user |
string |
将用于连接到Azure SQL数据库的用户名。 在 PUT (CreateOrReplace) 请求时是必需的。 |
type |
string:
Microsoft. |
指示将写入数据源输出的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
AzureTableOutputDataSource
描述 Azure 表输出数据源。
名称 | 类型 | 说明 |
---|---|---|
properties.accountKey |
string |
Azure 存储帐户的帐户密钥。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.accountName |
string |
Azure 存储帐户的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.batchSize |
integer |
一次写入 Azure 表的行数。 |
properties.columnsToRemove |
string[] |
如果已指定,则数组中的每个项将是要从输出事件实体中删除的列(如果存在)的名称。 |
properties.partitionKey |
string |
此元素指示查询中 SELECT 语句中的列的名称,该列将用作 Azure 表的分区键。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.rowKey |
string |
此元素指示查询中 SELECT 语句中的列名称,该列将用作 Azure 表的行键。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.table |
string |
Azure 表的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
type |
string:
Microsoft. |
指示将写入数据源输出的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
BlobOutputDataSource
描述 Blob 输出数据源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
properties.authenticationMode | ConnectionString |
身份验证模式。 |
|
properties.blobPathPrefix |
string |
Blob 路径前缀。 |
|
properties.container |
string |
关联存储帐户中容器的名称。 此容器包含要读取或写入的 blob () 。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.dateFormat |
string |
日期格式。 只要 {date} 出现在 pathPattern 中,此属性的值就用作日期格式。 |
|
properties.pathPattern |
string |
Blob 路径模式。 不是正则表达式。 它表示一种模式,根据该模式匹配 Blob 名称,以确定是否应将其作为输入或输出包含在作业中。 有关更详细的说明和示例,请参阅 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output 。 |
|
properties.storageAccounts |
一个或多个 Azure 存储帐户的列表。 在 PUT (CreateOrReplace) 请求时是必需的。 |
||
properties.timeFormat |
string |
时间格式。 只要 {time} 出现在 pathPattern 中,此属性的值将改为用作时间格式。 |
|
type |
string:
Microsoft. |
指示将写入数据源输出的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
BlobReferenceInputDataSource
描述包含引用数据的 Blob 输入数据源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
properties.authenticationMode | ConnectionString |
身份验证模式。 |
|
properties.container |
string |
关联存储帐户中容器的名称。 此容器包含要读取或写入的 blob () 。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.dateFormat |
string |
日期格式。 无论 {date} 出现在 pathPattern 中,此属性的值都改为用作日期格式。 |
|
properties.pathPattern |
string |
Blob 路径模式。 不是正则表达式。 它表示一种模式,根据该模式匹配 Blob 名称,以确定是否应将其作为输入或输出包含在作业中。 有关更详细的说明和示例,请参阅 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output 。 |
|
properties.storageAccounts |
一个或多个 Azure 存储帐户的列表。 在 PUT (CreateOrReplace) 请求时是必需的。 |
||
properties.timeFormat |
string |
时间格式。 无论 {time} 出现在 pathPattern 中的位置,此属性的值都改为用作时间格式。 |
|
type |
string:
Microsoft. |
指示包含引用数据的输入数据源的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
BlobStreamInputDataSource
描述包含流数据的 Blob 输入数据源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
properties.authenticationMode | ConnectionString |
身份验证模式。 |
|
properties.container |
string |
关联存储帐户中容器的名称。 此容器包含要读取或写入的 blob () 。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.dateFormat |
string |
日期格式。 只要 {date} 出现在 pathPattern 中,此属性的值就用作日期格式。 |
|
properties.pathPattern |
string |
Blob 路径模式。 不是正则表达式。 它表示一种模式,根据该模式匹配 Blob 名称,以确定是否应将其作为输入或输出包含在作业中。 有关更详细的说明和示例,请参阅 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output 。 |
|
properties.sourcePartitionCount |
integer |
Blob 输入数据源的分区计数。 范围 1 - 1024。 |
|
properties.storageAccounts |
一个或多个 Azure 存储帐户的列表。 在 PUT (CreateOrReplace) 请求时是必需的。 |
||
properties.timeFormat |
string |
时间格式。 只要 {time} 出现在 pathPattern 中,此属性的值将改为用作时间格式。 |
|
type |
string:
Microsoft. |
指示包含流数据的输入数据源的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
ClusterInfo
与流分析群集关联的属性。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
群集的资源 ID。 |
CompatibilityLevel
控制流式处理作业的某些运行时行为。
名称 | 类型 | 说明 |
---|---|---|
1.0 |
string |
|
1.2 |
string |
Compression
介绍如何压缩输入数据
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
type | None |
指示输入使用的压缩类型。 在 PUT (CreateOrReplace) 请求上是必需的。 |
CompressionType
指示输入使用的压缩类型。 在 PUT (CreateOrReplace) 请求时是必需的。
名称 | 类型 | 说明 |
---|---|---|
Deflate |
string |
|
GZip |
string |
|
None |
string |
ContentStoragePolicy
有效值为 JobStorageAccount 和 SystemAccount。 如果设置为 JobStorageAccount,则这要求用户同时指定 jobStorageAccount 属性。 .
名称 | 类型 | 说明 |
---|---|---|
JobStorageAccount |
string |
|
SystemAccount |
string |
CsvSerialization
描述如何序列化输入中的数据,或者在以 CSV 格式写入输出时如何序列化数据。
名称 | 类型 | 说明 |
---|---|---|
properties.encoding |
指定输入时传入数据的编码,在输出的情况下指定传出数据的编码。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
properties.fieldDelimiter |
string |
指定用于分隔 CSV) 记录 (逗号分隔值的分隔符。 有关支持值的列表,请参阅 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output 。 在 PUT (CreateOrReplace) 请求上是必需的。 |
type |
string:
Csv |
指示输入或输出使用的序列化类型。 在 PUT (CreateOrReplace) 请求上是必需的。 |
DiagnosticCondition
适用于资源或整体作业的条件,值得客户关注。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
不透明的诊断代码。 |
message |
string |
详细描述条件的可读消息。 在客户端请求的 Accept-Language 中本地化。 |
since |
string |
条件开始时的 UTC 时间戳。 此时,客户应该能够在操作日志中找到相应的事件。 |
Diagnostics
描述适用于输入、输出或整体作业的条件,这些条件值得客户关注。
名称 | 类型 | 说明 |
---|---|---|
conditions |
适用于资源或整个作业的零个或多个条件的集合,值得客户关注。 |
DocumentDbOutputDataSource
描述 DocumentDB 输出数据源。
名称 | 类型 | 说明 |
---|---|---|
properties.accountId |
string |
DocumentDB 帐户名称或 ID。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.accountKey |
string |
DocumentDB 帐户的帐户密钥。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.collectionNamePattern |
string |
要使用的集合的集合名称模式。 可以使用可选的 {partition} 令牌(其中分区从 0 开始)构造集合名称格式。 有关详细信息,请参阅 的 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output DocumentDB 部分。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.database |
string |
DocumentDB 数据库的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.documentId |
string |
输出事件中的字段的名称,该字段用于指定插入或更新操作所基于的主键。 |
properties.partitionKey |
string |
输出事件中的字段的名称,该字段用于指定跨集合分区输出的键。 如果“collectionNamePattern”包含 {partition} 令牌,则需要指定此属性。 |
type |
string:
Microsoft. |
指示将写入数据源输出的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
Encoding
指定输入时传入数据的编码,在输出的情况下指定传出数据的编码。
名称 | 类型 | 说明 |
---|---|---|
UTF8 |
string |
Error
常见错误表示形式。
名称 | 类型 | 说明 |
---|---|---|
error |
错误定义属性。 |
EventHubOutputDataSource
描述事件中心输出数据源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
authenticationMode | ConnectionString |
身份验证模式。 |
|
properties.eventHubName |
string |
事件中心的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.partitionKey |
string |
用于确定将事件数据发送到哪个分区的键/列。 |
|
properties.propertyColumns |
string[] |
与此事件中心输出关联的属性。 |
|
serviceBusNamespace |
string |
与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。在 PUT (CreateOrReplace) 请求时是必需的。 |
|
sharedAccessPolicyKey |
string |
指定共享访问策略的共享访问策略密钥。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
sharedAccessPolicyName |
string |
事件中心、服务总线队列、服务总线主题等的共享访问策略名称。在 PUT (CreateOrReplace) 请求时是必需的。 |
|
type |
string:
Microsoft. |
指示将写入数据源输出的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
EventHubStreamInputDataSource
描述包含流数据的事件中心输入数据源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
authenticationMode | ConnectionString |
身份验证模式。 |
|
properties.consumerGroupName |
string |
应用于从事件中心读取事件的事件中心使用者组的名称。 为多个输入指定不同的使用者组名称允许每个输入从事件中心接收相同的事件。 如果未指定,则输入将使用事件中心的默认使用者组。 |
|
properties.eventHubName |
string |
事件中心的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
serviceBusNamespace |
string |
与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。在 PUT (CreateOrReplace) 请求时是必需的。 |
|
sharedAccessPolicyKey |
string |
指定共享访问策略的共享访问策略密钥。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
sharedAccessPolicyName |
string |
事件中心、服务总线队列、服务总线主题等的共享访问策略名称。在 PUT (CreateOrReplace) 请求时是必需的。 |
|
type |
string:
Microsoft. |
指示包含流数据的输入数据源的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
EventHubV2OutputDataSource
描述事件中心输出数据源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
authenticationMode | ConnectionString |
身份验证模式。 |
|
properties.eventHubName |
string |
事件中心的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.partitionKey |
string |
用于确定将事件数据发送到哪个分区的键/列。 |
|
properties.propertyColumns |
string[] |
与此事件中心输出关联的属性。 |
|
serviceBusNamespace |
string |
与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。在 PUT (CreateOrReplace) 请求时是必需的。 |
|
sharedAccessPolicyKey |
string |
指定共享访问策略的共享访问策略密钥。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
sharedAccessPolicyName |
string |
事件中心、服务总线队列、服务总线主题等的共享访问策略名称。在 PUT (CreateOrReplace) 请求时是必需的。 |
|
type |
string:
Microsoft. |
指示将写入数据源输出的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
EventHubV2StreamInputDataSource
描述包含流数据的事件中心输入数据源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
authenticationMode | ConnectionString |
身份验证模式。 |
|
properties.consumerGroupName |
string |
应用于从事件中心读取事件的事件中心使用者组的名称。 为多个输入指定不同的使用者组名称允许每个输入从事件中心接收相同的事件。 如果未指定,则输入将使用事件中心的默认使用者组。 |
|
properties.eventHubName |
string |
事件中心的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
serviceBusNamespace |
string |
与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。在 PUT (CreateOrReplace) 请求时是必需的。 |
|
sharedAccessPolicyKey |
string |
指定共享访问策略的共享访问策略密钥。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
sharedAccessPolicyName |
string |
事件中心、服务总线队列、服务总线主题等的共享访问策略名称。在 PUT (CreateOrReplace) 请求时是必需的。 |
|
type |
string:
Microsoft. |
指示包含流数据的输入数据源的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
EventSerializationType
指示输入或输出使用的序列化类型。 在 PUT (CreateOrReplace) 请求时是必需的。
名称 | 类型 | 说明 |
---|---|---|
Avro |
string |
|
Csv |
string |
|
Json |
string |
|
Parquet |
string |
EventsOutOfOrderPolicy
指示要应用于输入事件流中未按顺序到达的事件的策略。
名称 | 类型 | 说明 |
---|---|---|
Adjust |
string |
|
Drop |
string |
FileReferenceInputDataSource
描述包含引用数据的文件输入数据源。
名称 | 类型 | 说明 |
---|---|---|
properties.path |
string |
文件的路径。 |
type |
string:
File |
指示包含引用数据的输入数据源的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
Function
一个函数对象,包含与命名函数关联的所有信息。 所有函数都包含在流式处理作业下。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID |
name |
string |
资源名称 |
properties | FunctionProperties: |
与函数关联的属性。 |
type |
string |
资源类型 |
FunctionInput
描述函数的一个输入参数。
名称 | 类型 | 说明 |
---|---|---|
dataType |
string |
(Azure 流分析支持的) 函数输入参数的数据类型。 有关有效 Azure 流分析数据类型的列表,请参阅 https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx |
isConfigurationParameter |
boolean |
指示参数是否为配置参数的标志。 如果此输入参数应为常量,则为 True。 默认值为 false。 |
FunctionOutput
描述函数的输出。
名称 | 类型 | 说明 |
---|---|---|
dataType |
string |
(Azure 流分析支持的函数输出) 数据类型。 有关有效 Azure 流分析数据类型的列表,请参阅 https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx |
GatewayMessageBusOutputDataSource
介绍网关消息总线输出数据源。
名称 | 类型 | 说明 |
---|---|---|
properties.topic |
string |
服务总线主题的名称。 |
type |
string:
Gateway |
指示将写入数据源输出的类型。 在 PUT (CreateOrReplace) 请求上是必需的。 |
GatewayMessageBusStreamInputDataSource
描述包含流数据的 Blob 输入数据源。
名称 | 类型 | 说明 |
---|---|---|
properties.topic |
string |
服务总线主题的名称。 |
type |
string:
Gateway |
指示包含流数据的输入数据源的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
Identity
描述如何验证标识
名称 | 类型 | 说明 |
---|---|---|
principalId |
string |
标识主体 ID |
tenantId |
string |
identity tenantId |
type |
string |
标识类型 |
Input
一个输入对象,包含与命名输入关联的所有信息。 所有输入都包含在流式处理作业下。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID |
name |
string |
资源名称 |
properties | InputProperties: |
与输入关联的属性。 在 PUT (CreateOrReplace) 请求上是必需的。 |
type |
string |
资源类型 |
IoTHubStreamInputDataSource
描述包含流数据的IoT 中心输入数据源。
名称 | 类型 | 说明 |
---|---|---|
properties.consumerGroupName |
string |
应用于从IoT 中心读取事件的IoT 中心使用者组的名称。 如果未指定,则输入将使用 IoT 中心的默认使用者组。 |
properties.endpoint |
string |
用于连接到 (的IoT 中心终结点,即 messages/events、messages/operationsMonitoringEvents 等 ) 。 |
properties.iotHubNamespace |
string |
IoT 中心的名称或 URI。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.sharedAccessPolicyKey |
string |
指定共享访问策略的共享访问策略密钥。 在 PUT (CreateOrReplace) 请求时是必需的。 |
properties.sharedAccessPolicyName |
string |
IoT 中心的共享访问策略名称。 此策略必须至少包含服务连接权限。 在 PUT (CreateOrReplace) 请求时是必需的。 |
type |
string:
Microsoft. |
指示包含流数据的输入数据源的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
JavaScriptFunctionBinding
绑定到 JavaScript 函数。
名称 | 类型 | 说明 |
---|---|---|
properties.script |
string |
包含单个函数定义的 JavaScript 代码。 例如:'function (x, y) { return x + y; }' |
type |
string:
Microsoft. |
指示函数绑定类型。 |
JobStorageAccount
与具有 MSI 的 Azure 存储帐户关联的属性
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
accountKey |
string |
Azure 存储帐户的帐户密钥。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
accountName |
string |
Azure 存储帐户的名称。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
authenticationMode | ConnectionString |
身份验证模式。 |
JobType
描述作业的类型。 有效模式为 Cloud
和 “Edge”。
名称 | 类型 | 说明 |
---|---|---|
Cloud |
string |
|
Edge |
string |
JsonOutputSerializationFormat
指定将写入输出的 JSON 的格式。 当前支持的值是“lineSeparated”,指示输出的格式将由新行分隔,“array”指示输出将格式化为 JSON 对象的数组。
名称 | 类型 | 说明 |
---|---|---|
Array |
string |
|
LineSeparated |
string |
JsonSerialization
描述如何序列化输入中的数据,或者在以 JSON 格式写入输出时如何序列化数据。
名称 | 类型 | 说明 |
---|---|---|
properties.encoding |
指定输入时传入数据的编码,在输出的情况下指定传出数据的编码。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
properties.format |
此属性仅适用于输出的 JSON 序列化。 它不适用于输入。 此属性指定将写入输出的 JSON 的格式。 当前支持的值是“lineSeparated”,指示输出的格式将由新行分隔,“array”指示输出将格式化为 JSON 对象的数组。 如果为 null,则默认值为“lineSeparated”。 |
|
type |
string:
Json |
指示输入或输出使用的序列化类型。 在 PUT (CreateOrReplace) 请求上是必需的。 |
Output
一个输出对象,包含与命名输出关联的所有信息。 所有输出都包含在流式处理作业下。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID |
name |
string |
资源名称 |
properties.datasource |
OutputDataSource:
|
描述将写入输出的数据源。 在 PUT (CreateOrReplace) 请求上是必需的。 |
properties.diagnostics |
描述适用于输入、输出或整体作业的条件,这些条件应引起客户的关注。 |
|
properties.etag |
string |
输出的当前实体标记。 这是一个不透明的字符串。 可以使用它来检测资源是否在请求之间发生了更改。 还可以在 If-Match 或 If-None-Match 标头中使用它进行写入操作,实现乐观并发。 |
properties.serialization | Serialization: |
描述如何序列化输入中的数据,或者在写入输出时如何序列化数据。 在 PUT (CreateOrReplace) 请求上是必需的。 |
properties.sizeWindow |
integer |
将流分析输出约束到的大小窗口。 |
properties.timeWindow |
string |
筛选流分析作业输出的时间范围。 |
type |
string |
资源类型 |
OutputErrorPolicy
指示要应用于到达输出但由于格式错误(缺少列值、列值类型或大小错误)而无法写入外部存储的事件的策略。
名称 | 类型 | 说明 |
---|---|---|
Drop |
string |
|
Stop |
string |
OutputStartMode
值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指示输出事件流的起点应每当作业启动时启动、从通过 outputStartTime 属性指定的自定义用户时间戳开始,还是从上次事件输出时间开始。
名称 | 类型 | 说明 |
---|---|---|
CustomTime |
string |
|
JobStartTime |
string |
|
LastOutputEventTime |
string |
ParquetSerialization
描述如何序列化输入中的数据,或者在以 Parquet 格式写入输出时如何序列化数据。
名称 | 类型 | 说明 |
---|---|---|
type |
string:
Parquet |
指示输入或输出使用的序列化类型。 在 PUT (CreateOrReplace) 请求上是必需的。 |
PowerBIOutputDataSource
介绍 Power BI 输出数据源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
properties.authenticationMode | ConnectionString |
身份验证模式。 |
|
properties.dataset |
string |
Power BI 数据集的名称。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
properties.groupId |
string |
Power BI 组的 ID。 |
|
properties.groupName |
string |
Power BI 组的名称。 使用此属性有助于记住使用了哪个特定的 Power BI 组 ID。 |
|
properties.refreshToken |
string |
一个刷新令牌,可用于获取有效的访问令牌,然后可用于对数据源进行身份验证。 有效的刷新令牌目前只能通过 Azure 门户获取。 建议在创建数据源时在此处放置一个虚拟字符串值,然后转到 Azure 门户对数据源进行身份验证,该数据源将使用有效的刷新令牌更新此属性。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
properties.table |
string |
指定数据集下的 Power BI 表的名称。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
properties.tokenUserDisplayName |
string |
用于获取刷新令牌的用户的用户显示名称。 使用此属性可帮助记住使用哪个用户获取刷新令牌。 |
|
properties.tokenUserPrincipalName |
string |
用户主体名称 (用于获取刷新令牌的用户的 UPN) 。 使用此属性可帮助记住使用哪个用户获取刷新令牌。 |
|
type |
string:
PowerBI |
指示将写入数据源输出的类型。 在 PUT (CreateOrReplace) 请求上是必需的。 |
ReferenceInputProperties
与包含引用数据的输入关联的属性。
名称 | 类型 | 说明 |
---|---|---|
compression |
介绍如何压缩输入数据 |
|
datasource | ReferenceInputDataSource: |
描述包含引用数据的输入数据源。 在 PUT (CreateOrReplace) 请求时是必需的。 |
diagnostics |
描述适用于输入、输出或整体作业的条件,这些条件值得客户关注。 |
|
etag |
string |
输入的当前实体标记。 这是一个不透明的字符串。 可以使用它来检测资源是否在请求之间发生了更改。 还可以在 If-Match 或 If-None-Match 标头中使用它进行乐观并发的写入操作。 |
partitionKey |
string |
partitionKey 描述输入数据中用于对输入数据进行分区的键 |
serialization | Serialization: |
描述如何序列化输入中的数据,或者在写入输出时如何序列化数据。 在 PUT (CreateOrReplace) 请求时是必需的。 |
type |
string:
Reference |
指示输入是引用数据还是流数据的源。 在 PUT (CreateOrReplace) 请求时是必需的。 |
RefreshType
指示数据刷新选项的类型。
名称 | 类型 | 说明 |
---|---|---|
RefreshPeriodicallyWithDelta |
string |
|
RefreshPeriodicallyWithFull |
string |
|
Static |
string |
ScalarFunctionProperties
与标量函数关联的属性。
名称 | 类型 | 说明 |
---|---|---|
etag |
string |
函数的当前实体标记。 这是一个不透明的字符串。 可以使用它来检测资源是否在请求之间发生了更改。 还可以在 If-Match 或 If-None-Match 标头中使用它进行写入操作,实现乐观并发。 |
properties.binding | FunctionBinding: |
函数的物理绑定。 例如,在 Azure 机器学习 Web 服务的情况下,它描述了终结点。 |
properties.inputs |
描述函数的一个输入参数。 |
|
properties.output |
描述函数的输出。 |
|
type |
string:
Scalar |
指示函数的类型。 |
ServiceBusQueueOutputDataSource
描述服务总线队列输出数据源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
properties.authenticationMode | ConnectionString |
身份验证模式。 |
|
properties.propertyColumns |
string[] |
要作为自定义属性附加到服务总线消息的输出列名称的字符串数组。 |
|
properties.queueName |
string |
服务总线队列的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.serviceBusNamespace |
string |
与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.sharedAccessPolicyKey |
string |
指定共享访问策略的共享访问策略密钥。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.sharedAccessPolicyName |
string |
事件中心、服务总线队列、服务总线主题等的共享访问策略名称。在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.systemPropertyColumns |
object |
与服务总线队列关联的系统属性。 支持以下系统属性:ReplyToSessionId、ContentType、To、Subject、CorrelationId、TimeToLive、PartitionKey、SessionId、ScheduledEnqueueTime、MessageId、ReplyTo、Label、ScheduledEnqueueTimeUtc。 |
|
type |
string:
Microsoft. |
指示将写入数据源输出的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
ServiceBusTopicOutputDataSource
描述服务总线主题输出数据源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
properties.authenticationMode | ConnectionString |
身份验证模式。 |
|
properties.propertyColumns |
string[] |
要作为自定义属性附加到服务总线消息的输出列名称的字符串数组。 |
|
properties.serviceBusNamespace |
string |
与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.sharedAccessPolicyKey |
string |
指定共享访问策略的共享访问策略密钥。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
properties.sharedAccessPolicyName |
string |
事件中心、服务总线队列、服务总线主题等的共享访问策略名称。在 PUT (CreateOrReplace) 请求时是必需的。 |
|
properties.systemPropertyColumns |
object |
与服务总线主题输出关联的系统属性。 支持以下系统属性:ReplyToSessionId、ContentType、To、Subject、CorrelationId、TimeToLive、PartitionKey、SessionId、ScheduledEnqueueTime、MessageId、ReplyTo、Label、ScheduledEnqueueTimeUtc。 |
|
properties.topicName |
string |
服务总线主题的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
|
type |
string:
Microsoft. |
指示将写入数据源输出的类型。 在 PUT (CreateOrReplace) 请求时是必需的。 |
Sku
与 SKU 关联的属性。
名称 | 类型 | 说明 |
---|---|---|
name |
SKU 的名称。 在 PUT (CreateOrReplace) 请求上是必需的。 |
SkuName
SKU 的名称。 在 PUT (CreateOrReplace) 请求时是必需的。
名称 | 类型 | 说明 |
---|---|---|
Standard |
string |
StorageAccount
与 Azure 存储帐户关联的属性
名称 | 类型 | 说明 |
---|---|---|
accountKey |
string |
Azure 存储帐户的帐户密钥。 在 PUT (CreateOrReplace) 请求时是必需的。 |
accountName |
string |
Azure 存储帐户的名称。 在 PUT (CreateOrReplace) 请求时是必需的。 |
StreamingJob
一个流式处理作业对象,包含与命名流式处理作业关联的所有信息。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
介绍分配给此作业的系统分配托管标识,该标识可用于通过输入和输出进行身份验证。 |
|
location |
string |
资源所在的地理位置 |
name |
string |
资源的名称 |
properties.cluster |
将运行流式处理作业的群集。 |
|
properties.compatibilityLevel |
控制流式处理作业的某些运行时行为。 |
|
properties.contentStoragePolicy |
有效值为 JobStorageAccount 和 SystemAccount。 如果设置为 JobStorageAccount,则这要求用户同时指定 jobStorageAccount 属性。 . |
|
properties.createdDate |
string |
值是 ISO-8601 格式的 UTC 时间戳,指示创建流式处理作业的时间。 |
properties.dataLocale |
string |
流分析作业的数据区域设置。 值应为集 https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx中支持的 .NET 区域性的名称。 如果未指定,则默认为“en-US”。 |
properties.etag |
string |
流式处理作业的当前实体标记。 这是一个不透明的字符串。 可以使用它来检测资源是否在请求之间发生了更改。 还可以在 If-Match 或 If-None-Match 标头中使用它进行乐观并发的写入操作。 |
properties.eventsLateArrivalMaxDelayInSeconds |
integer |
可容忍的最大延迟(以秒为单位),其中可能包括迟到事件。 支持的范围为 -1 到 1814399(20.23:59:59 天),-1 用于指定无限期等待。 如果该属性不存在,则将其解释为具有值 -1。 |
properties.eventsOutOfOrderMaxDelayInSeconds |
integer |
可容许的最大延迟(以秒为单位),其中无序事件可重新调整为有序事件。 |
properties.eventsOutOfOrderPolicy |
指示要应用于输入事件流中未按顺序到达的事件的策略。 |
|
properties.functions |
Function[] |
流式处理作业的一个或多个函数的列表。 在 PUT 请求中指定此属性时,需要每个函数的 name 属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个转换的 PATCH API。 |
properties.inputs |
Input[] |
流式处理作业的一个或多个输入的列表。 在 PUT 请求中指定此属性时,每个输入的名称属性是必需的。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个输入的 PATCH API。 |
properties.jobId |
string |
唯一标识流式处理作业的 GUID。 此 GUID 是在创建流式处理作业时生成的。 |
properties.jobState |
string |
描述流式处理作业的状态。 |
properties.jobStorageAccount |
与具有 MSI 的 Azure 存储帐户关联的属性 |
|
properties.jobType |
描述作业的类型。 有效模式为 |
|
properties.lastOutputEventTime |
string |
值为 ISO-8601 格式的时间戳,指示流式处理作业的最后一个输出事件时间,或 null,表示尚未生成输出。 如果有多个输出或多个流,则显示该集中的最新值。 |
properties.outputErrorPolicy |
指示要应用于到达输出但由于格式错误(缺少列值、列值类型或大小错误)而无法写入外部存储的事件的策略。 |
|
properties.outputStartMode |
仅当需要作业在创建时立即启动时才应使用此属性。 值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指示输出事件流的起点应在作业每次启动时启动、从通过 outputStartTime 属性指定的自定义用户时间戳开始,还是从上次事件输出时间开始。 |
|
properties.outputStartTime |
string |
值为采用 ISO-8601 格式的时间戳(指示输出事件流的起点),或者为 null(指示输出事件流将在每次启动流式处理作业时开始)。 如果 outputStartMode 设置为 CustomTime,则此属性必须具有值。 |
properties.outputs |
Output[] |
流式处理作业的一个或多个输出的列表。 在 PUT 请求中指定此属性时,需要每个输出的 name 属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个输出的 PATCH API。 |
properties.provisioningState |
string |
描述流式处理作业的预配状态。 |
properties.sku |
描述流式处理作业的 SKU。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
properties.transformation |
指示用于流式处理作业的查询和流单元数。 在 PUT 请求中指定此属性时,需要转换的 name 属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个转换的 PATCH API。 |
|
tags |
object |
资源标记。 |
type |
string |
资源类型。 Ex- Microsoft.Compute/virtualMachines 或 Microsoft.Storage/storageAccounts。 |
StreamInputProperties
与包含流数据的输入关联的属性。
名称 | 类型 | 说明 |
---|---|---|
compression |
介绍如何压缩输入数据 |
|
datasource | StreamInputDataSource: |
描述包含流数据的输入数据源。 在 PUT (CreateOrReplace) 请求时是必需的。 |
diagnostics |
描述适用于输入、输出或整体作业的条件,这些条件值得客户关注。 |
|
etag |
string |
输入的当前实体标记。 这是一个不透明的字符串。 可以使用它来检测资源是否在请求之间发生了更改。 还可以在 If-Match 或 If-None-Match 标头中使用它进行乐观并发的写入操作。 |
partitionKey |
string |
partitionKey 描述输入数据中用于对输入数据进行分区的键 |
serialization | Serialization: |
描述如何序列化输入中的数据,或者在写入输出时如何序列化数据。 在 PUT (CreateOrReplace) 请求时是必需的。 |
type |
string:
Stream |
指示输入是引用数据还是流数据的源。 在 PUT (CreateOrReplace) 请求时是必需的。 |
Transformation
一个转换对象,包含与命名转换关联的所有信息。 所有转换都包含在流式处理作业下。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
id |
string |
资源 ID |
|
name |
string |
资源名称 |
|
properties.etag |
string |
转换的当前实体标记。 这是一个不透明的字符串。 可以使用它来检测资源是否在请求之间发生了更改。 还可以在 If-Match 或 If-None-Match 标头中使用它进行写入操作,实现乐观并发。 |
|
properties.query |
string |
指定将在流式处理作业中运行的查询。 可以在此处详细了解流分析查询语言 (SAQL) : https://msdn.microsoft.com/library/azure/dn834998 。 在 PUT (CreateOrReplace) 请求上是必需的。 |
|
properties.streamingUnits |
integer |
3 |
指定流式处理作业使用的流单元数。 |
properties.validStreamingUnits |
integer[] |
指定流式处理作业可以缩放到的有效流单元。 |
|
type |
string |
资源类型 |