Inputs - Create Or Replace
创建输入或替换现有流式处理作业下已有的输入。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/inputs/{inputName}?api-version=2020-03-01
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
input
|
path | True |
string |
输入的名称。 |
|
job
|
path | True |
string |
流式处理作业的名称。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+$ |
资源组的名称。 名称不区分大小写。 |
|
subscription
|
path | True |
string minLength: 1 |
目标订阅的 ID。 |
|
api-version
|
query | True |
string minLength: 1 |
用于此作的 API 版本。 |
请求头
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| If-Match |
string |
输入的 ETag。 省略此值以始终覆盖当前输入。 指定最后一次看到的 ETag 值,以防止意外覆盖并发更改。 |
|
| If-None-Match |
string |
设置为“*”以允许创建新输入,但要防止更新现有输入。 其他值将导致 412 预条件失败响应。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
资源名称 |
| properties | InputProperties: |
与输入关联的属性。 PUT (CreateOrReplace) 请求时是必需的。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 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 Gateway Message Bus input
示例请求
PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg3467/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970?api-version=2020-03-01
{
"properties": {
"type": "Stream",
"datasource": {
"type": "GatewayMessageBus",
"properties": {
"topic": "EdgeTopic1"
}
}
}
}
示例响应
ETag: bd8009b3-8165-4bd3-aad2-29a2b378dd14
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3467/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970",
"name": "input7970",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Stream",
"datasource": {
"type": "GatewayMessageBus",
"properties": {
"topic": "EdgeTopic1"
}
}
}
}
ETag: bd8009b3-8165-4bd3-aad2-29a2b378dd14
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3467/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970",
"name": "input7970",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Stream",
"datasource": {
"type": "GatewayMessageBus",
"properties": {
"topic": "EdgeTopic1"
}
}
}
}
Create a reference blob input with CSV serialization
示例请求
PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225?api-version=2020-03-01
{
"properties": {
"type": "Reference",
"datasource": {
"type": "Microsoft.Storage/Blob",
"properties": {
"storageAccounts": [
{
"accountName": "someAccountName",
"accountKey": "someAccountKey=="
}
],
"container": "state",
"pathPattern": "{date}/{time}",
"dateFormat": "yyyy/MM/dd",
"timeFormat": "HH"
}
},
"serialization": {
"type": "Csv",
"properties": {
"fieldDelimiter": ",",
"encoding": "UTF8"
}
}
}
}
示例响应
ETag: c987701d-4039-47aa-a115-ad84f67d07c5
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225",
"name": "input7225",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Reference",
"datasource": {
"type": "Microsoft.Storage/Blob",
"properties": {
"storageAccounts": [
{
"accountName": "someAccountName"
}
],
"container": "state",
"pathPattern": "{date}/{time}",
"dateFormat": "yyyy/MM/dd",
"timeFormat": "HH"
}
},
"serialization": {
"type": "Csv",
"properties": {
"fieldDelimiter": ",",
"encoding": "UTF8"
}
}
}
}
ETag: c987701d-4039-47aa-a115-ad84f67d07c5
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225",
"name": "input7225",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Reference",
"datasource": {
"type": "Microsoft.Storage/Blob",
"properties": {
"storageAccounts": [
{
"accountName": "someAccountName"
}
],
"container": "state",
"pathPattern": "{date}/{time}",
"dateFormat": "yyyy/MM/dd",
"timeFormat": "HH"
}
},
"serialization": {
"type": "Csv",
"properties": {
"fieldDelimiter": ",",
"encoding": "UTF8"
}
}
}
}
Create a reference file input
示例请求
PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225?api-version=2020-03-01
{
"properties": {
"type": "Reference",
"datasource": {
"type": "File",
"properties": {
"path": "my/path"
}
}
}
}
示例响应
ETag: c987701d-4039-47aa-a115-ad84f67d07c5
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225",
"name": "input7225",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Reference",
"datasource": {
"type": "File",
"properties": {
"path": "my/path"
}
}
}
}
ETag: c987701d-4039-47aa-a115-ad84f67d07c5
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225",
"name": "input7225",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Reference",
"datasource": {
"type": "File",
"properties": {
"path": "my/path"
}
}
}
}
Create a stream blob input with CSV serialization
示例请求
PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg8161/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899?api-version=2020-03-01
{
"properties": {
"type": "Stream",
"datasource": {
"type": "Microsoft.Storage/Blob",
"properties": {
"storageAccounts": [
{
"accountName": "someAccountName",
"accountKey": "someAccountKey=="
}
],
"container": "state",
"pathPattern": "{date}/{time}",
"dateFormat": "yyyy/MM/dd",
"timeFormat": "HH",
"sourcePartitionCount": 16
}
},
"serialization": {
"type": "Csv",
"properties": {
"fieldDelimiter": ",",
"encoding": "UTF8"
}
}
}
}
示例响应
ETag: 475074b8-c957-4b1f-a219-12b8399c3d4c
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8161/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899",
"name": "input8899",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Stream",
"datasource": {
"type": "Microsoft.Storage/Blob",
"properties": {
"sourcePartitionCount": 16,
"storageAccounts": [
{
"accountName": "someAccountName"
}
],
"container": "state",
"pathPattern": "{date}/{time}",
"dateFormat": "yyyy/MM/dd",
"timeFormat": "HH"
}
},
"serialization": {
"type": "Csv",
"properties": {
"fieldDelimiter": ",",
"encoding": "UTF8"
}
}
}
}
ETag: 475074b8-c957-4b1f-a219-12b8399c3d4c
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8161/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899",
"name": "input8899",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Stream",
"datasource": {
"type": "Microsoft.Storage/Blob",
"properties": {
"sourcePartitionCount": 16,
"storageAccounts": [
{
"accountName": "someAccountName"
}
],
"container": "state",
"pathPattern": "{date}/{time}",
"dateFormat": "yyyy/MM/dd",
"timeFormat": "HH"
}
},
"serialization": {
"type": "Csv",
"properties": {
"fieldDelimiter": ",",
"encoding": "UTF8"
}
}
}
}
Create a stream Event Hub input with JSON serialization
示例请求
PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg3139/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425?api-version=2020-03-01
{
"properties": {
"type": "Stream",
"datasource": {
"type": "Microsoft.ServiceBus/EventHub",
"properties": {
"serviceBusNamespace": "sdktest",
"sharedAccessPolicyName": "RootManageSharedAccessKey",
"sharedAccessPolicyKey": "someSharedAccessPolicyKey==",
"eventHubName": "sdkeventhub",
"consumerGroupName": "sdkconsumergroup"
}
},
"serialization": {
"type": "Json",
"properties": {
"encoding": "UTF8"
}
}
}
}
示例响应
ETag: afd0d184-37e9-4370-9e55-32501bc4de3a
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3139/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425",
"name": "input7425",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Stream",
"datasource": {
"type": "Microsoft.ServiceBus/EventHub",
"properties": {
"eventHubName": "sdkeventhub",
"consumerGroupName": "sdkconsumergroup",
"serviceBusNamespace": "sdktest",
"sharedAccessPolicyName": "RootManageSharedAccessKey"
}
},
"serialization": {
"type": "Json",
"properties": {
"encoding": "UTF8"
}
}
}
}
ETag: afd0d184-37e9-4370-9e55-32501bc4de3a
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3139/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425",
"name": "input7425",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Stream",
"datasource": {
"type": "Microsoft.ServiceBus/EventHub",
"properties": {
"eventHubName": "sdkeventhub",
"consumerGroupName": "sdkconsumergroup",
"serviceBusNamespace": "sdktest",
"sharedAccessPolicyName": "RootManageSharedAccessKey"
}
},
"serialization": {
"type": "Json",
"properties": {
"encoding": "UTF8"
}
}
}
}
Create a stream IoT Hub input with Avro serialization
示例请求
PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg3467/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970?api-version=2020-03-01
{
"properties": {
"type": "Stream",
"datasource": {
"type": "Microsoft.Devices/IotHubs",
"properties": {
"iotHubNamespace": "iothub",
"sharedAccessPolicyName": "owner",
"sharedAccessPolicyKey": "sharedAccessPolicyKey=",
"consumerGroupName": "sdkconsumergroup",
"endpoint": "messages/events"
}
},
"serialization": {
"type": "Avro"
}
}
}
示例响应
ETag: bd8009b3-8165-4bd3-aad2-29a2b378dd14
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3467/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970",
"name": "input7970",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Stream",
"datasource": {
"type": "Microsoft.Devices/IotHubs",
"properties": {
"iotHubNamespace": "iothub",
"sharedAccessPolicyName": "owner",
"endpoint": "messages/events",
"consumerGroupName": "sdkconsumergroup"
}
},
"serialization": {
"type": "Avro",
"properties": {}
}
}
}
ETag: bd8009b3-8165-4bd3-aad2-29a2b378dd14
{
"id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3467/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970",
"name": "input7970",
"type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
"properties": {
"type": "Stream",
"datasource": {
"type": "Microsoft.Devices/IotHubs",
"properties": {
"iotHubNamespace": "iothub",
"sharedAccessPolicyName": "owner",
"endpoint": "messages/events",
"consumerGroupName": "sdkconsumergroup"
}
},
"serialization": {
"type": "Avro",
"properties": {}
}
}
}
定义
| 名称 | 说明 |
|---|---|
|
Authentication |
身份验证模式。 有效模式 |
|
Avro |
描述如何序列化来自输入的数据,或者当以 Avro 格式写入输出时如何序列化数据。 |
|
Azure |
介绍 Azure SQL 数据库引用输入数据源。 |
|
Blob |
描述包含引用数据的 Blob 输入数据源。 |
|
Blob |
描述包含流数据的 Blob 输入数据源。 |
| Compression |
描述如何压缩输入数据 |
|
Compression |
指示输入使用的压缩类型。 PUT (CreateOrReplace) 请求时是必需的。 |
|
Csv |
描述如何序列化输入中的数据,或者将数据写入 CSV 格式时如何序列化数据。 |
|
Diagnostic |
适用于资源或整体作业的条件,值得客户注意。 |
| Diagnostics |
描述适用于整体输入、输出或作业的条件,这些条件值得客户注意。 |
| Encoding |
指定传入数据的编码(在输入的情况下)和输出时传出数据的编码。 |
| Error |
常见的错误表示形式。 |
|
Event |
描述包含流数据的事件中心输入数据源。 |
|
Event |
描述包含流数据的事件中心输入数据源。 |
|
Event |
指示输入或输出使用的序列化类型。 PUT (CreateOrReplace) 请求时是必需的。 |
|
File |
描述包含引用数据的文件输入数据源。 |
|
Gateway |
描述包含流数据的 Blob 输入数据源。 |
| Input |
一个输入对象,包含与命名输入关联的所有信息。 所有输入都包含在流式处理作业下。 |
|
Io |
描述包含流数据的 IoT 中心输入数据源。 |
|
Json |
指定输出将写入的 JSON 的格式。 当前支持的值是“lineSeparated”,指示输出将设置格式,方法是让每个 JSON 对象用新行分隔,“array”指示输出将格式化为 JSON 对象的数组。 |
|
Json |
描述如何序列化输入中的数据,或者以 JSON 格式写入输出时如何序列化数据。 |
|
Parquet |
描述如何序列化输入中的数据,或者当以 Parquet 格式写入输出时如何序列化数据。 |
|
Reference |
与包含引用数据的输入关联的属性。 |
|
Refresh |
指示数据刷新选项的类型。 |
|
Storage |
与 Azure 存储帐户关联的属性 |
|
Stream |
与包含流数据的输入关联的属性。 |
AuthenticationMode
身份验证模式。 有效模式 ConnectionString、Msi 和“UserToken”。
| 值 | 说明 |
|---|---|
| Msi | |
| UserToken | |
| ConnectionString |
AvroSerialization
描述如何序列化来自输入的数据,或者当以 Avro 格式写入输出时如何序列化数据。
| 名称 | 类型 | 说明 |
|---|---|---|
| type |
string:
Avro |
指示输入或输出使用的序列化类型。 PUT (CreateOrReplace) 请求时是必需的。 |
AzureSqlReferenceInputDataSource
介绍 Azure SQL 数据库引用输入数据源。
| 名称 | 类型 | 说明 |
|---|---|---|
| properties.database |
string |
此元素与数据源元素相关联。 这是输出将写入到的数据库的名称。 |
| properties.deltaSnapshotQuery |
string |
此元素与数据源元素相关联。 此查询用于从 SQL 数据库提取增量更改。 若要使用此选项,建议在 Azure SQL 数据库中使用临时表。 |
| properties.fullSnapshotQuery |
string |
此元素与数据源元素相关联。 此查询用于从 sql 数据库提取数据。 |
| properties.password |
string |
此元素与数据源元素相关联。 这是用于连接到 SQL 数据库实例的密码。 |
| properties.refreshRate |
string |
此元素与数据源元素相关联。 这表示从数据库提取数据的频率。 它采用 DateTime 格式。 |
| properties.refreshType |
指示数据刷新选项的类型。 |
|
| properties.server |
string |
此元素与数据源元素相关联。 这是包含要写入的数据库的服务器的名称。 |
| properties.table |
string |
此元素与数据源元素相关联。 Azure SQL 数据库中表的名称。 |
| properties.user |
string |
此元素与数据源元素相关联。 这是用于连接到 SQL 数据库实例的用户名。 |
| type |
string:
Microsoft. |
指示包含引用数据的输入数据源的类型。 PUT (CreateOrReplace) 请求时是必需的。 |
BlobReferenceInputDataSource
描述包含引用数据的 Blob 输入数据源。
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| properties.authenticationMode | ConnectionString |
身份验证模式。 |
|
| properties.container |
string |
关联的存储帐户中的容器的名称。 此容器包含要从中读取或写入到的 blob(s)。 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(s)。 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 (int32) |
Blob 输入数据源的分区计数。 范围 1 - 1024。 |
|
| properties.storageAccounts |
一个或多个 Azure 存储帐户的列表。 PUT (CreateOrReplace) 请求时是必需的。 |
||
| properties.timeFormat |
string |
时间格式。 无论 {time} 出现在 pathPattern 中,此属性的值将改为用作时间格式。 |
|
| type |
string:
Microsoft. |
指示包含流数据的输入数据源的类型。 PUT (CreateOrReplace) 请求时是必需的。 |
Compression
描述如何压缩输入数据
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| type | None |
指示输入使用的压缩类型。 PUT (CreateOrReplace) 请求时是必需的。 |
CompressionType
指示输入使用的压缩类型。 PUT (CreateOrReplace) 请求时是必需的。
| 值 | 说明 |
|---|---|
| None | |
| GZip | |
| Deflate |
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 |
适用于资源或整体作业的零个或多个条件的集合,值得客户注意。 |
Encoding
指定传入数据的编码(在输入的情况下)和输出时传出数据的编码。
| 值 | 说明 |
|---|---|
| UTF8 |
Error
常见的错误表示形式。
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误定义属性。 |
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) 请求时是必需的。 |
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) 请求时是必需的。
| 值 | 说明 |
|---|---|
| Csv | |
| Avro | |
| Json | |
| Parquet |
FileReferenceInputDataSource
描述包含引用数据的文件输入数据源。
| 名称 | 类型 | 说明 |
|---|---|---|
| properties.path |
string |
文件的路径。 |
| type |
string:
File |
指示包含引用数据的输入数据源的类型。 PUT (CreateOrReplace) 请求时是必需的。 |
GatewayMessageBusStreamInputDataSource
描述包含流数据的 Blob 输入数据源。
| 名称 | 类型 | 说明 |
|---|---|---|
| properties.topic |
string |
服务总线主题的名称。 |
| type |
string:
Gateway |
指示包含流数据的输入数据源的类型。 PUT (CreateOrReplace) 请求时是必需的。 |
Input
一个输入对象,包含与命名输入关联的所有信息。 所有输入都包含在流式处理作业下。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
资源 ID |
| name |
string |
资源名称 |
| properties | InputProperties: |
与输入关联的属性。 PUT (CreateOrReplace) 请求时是必需的。 |
| type |
string |
资源类型 |
IoTHubStreamInputDataSource
描述包含流数据的 IoT 中心输入数据源。
| 名称 | 类型 | 说明 |
|---|---|---|
| properties.consumerGroupName |
string |
应用于从 IoT 中心读取事件的 IoT 中心使用者组的名称。 如果未指定,则输入使用 Iot 中心的默认使用者组。 |
| properties.endpoint |
string |
要连接到的 IoT 中心终结点(例如消息/事件、消息/operationsMonitoringEvents 等)。 |
| properties.iotHubNamespace |
string |
IoT 中心的名称或 URI。 PUT (CreateOrReplace) 请求时是必需的。 |
| properties.sharedAccessPolicyKey |
string |
指定共享访问策略的共享访问策略密钥。 PUT (CreateOrReplace) 请求时是必需的。 |
| properties.sharedAccessPolicyName |
string |
IoT 中心的共享访问策略名称。 此策略必须至少包含服务连接权限。 PUT (CreateOrReplace) 请求时是必需的。 |
| type |
string:
Microsoft. |
指示包含流数据的输入数据源的类型。 PUT (CreateOrReplace) 请求时是必需的。 |
JsonOutputSerializationFormat
指定输出将写入的 JSON 的格式。 当前支持的值是“lineSeparated”,指示输出将设置格式,方法是让每个 JSON 对象用新行分隔,“array”指示输出将格式化为 JSON 对象的数组。
| 值 | 说明 |
|---|---|
| LineSeparated | |
| Array |
JsonSerialization
描述如何序列化输入中的数据,或者以 JSON 格式写入输出时如何序列化数据。
| 名称 | 类型 | 说明 |
|---|---|---|
| properties.encoding |
指定传入数据的编码(在输入的情况下)和输出时传出数据的编码。 PUT (CreateOrReplace) 请求时是必需的。 |
|
| properties.format |
此属性仅适用于输出的 JSON 序列化。 它不适用于输入。 此属性指定输出将写入的 JSON 的格式。 当前支持的值是“lineSeparated”,指示输出将设置格式,方法是让每个 JSON 对象用新行分隔,“array”指示输出将格式化为 JSON 对象的数组。 如果为 null,则默认值为“lineSeparated”。 |
|
| type |
string:
Json |
指示输入或输出使用的序列化类型。 PUT (CreateOrReplace) 请求时是必需的。 |
ParquetSerialization
描述如何序列化输入中的数据,或者当以 Parquet 格式写入输出时如何序列化数据。
| 名称 | 类型 | 说明 |
|---|---|---|
| type |
string:
Parquet |
指示输入或输出使用的序列化类型。 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
指示数据刷新选项的类型。
| 值 | 说明 |
|---|---|
| Static | |
| RefreshPeriodicallyWithFull | |
| RefreshPeriodicallyWithDelta |
StorageAccount
与 Azure 存储帐户关联的属性
| 名称 | 类型 | 说明 |
|---|---|---|
| accountKey |
string |
Azure 存储帐户的帐户密钥。 PUT (CreateOrReplace) 请求时是必需的。 |
| accountName |
string |
Azure 存储帐户的名称。 PUT (CreateOrReplace) 请求时是必需的。 |
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) 请求时是必需的。 |