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 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
input
|
path | True |
string |
輸入的名稱。 |
job
|
path | True |
string |
串流作業的名稱。 |
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 Regex 模式: |
subscription
|
path | True |
string |
目標訂用帳戶的標識碼。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
If-Match |
string |
輸入的 ETag。 請省略此值以一律覆寫目前的輸入。 指定上次出現的 ETag 值,以防止意外覆寫並行變更。 |
|
If-None-Match |
string |
設定為 『*』 以允許建立新的輸入,但為了避免更新現有的輸入。 其他值會導致 412 前置條件失敗回應。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
name |
string |
資源名稱 |
properties | InputProperties: |
與輸入相關聯的屬性。 PUT (CreateOrReplace) 要求上的必要專案。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
已成功建立或取代輸入。 標題 ETag: string |
|
201 Created |
已成功建立或取代輸入。 標題 ETag: string |
|
Other Status Codes |
錯誤。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
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": {}
}
}
}
定義
名稱 | Description |
---|---|
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』。
名稱 | 類型 | Description |
---|---|---|
ConnectionString |
string |
|
Msi |
string |
|
UserToken |
string |
AvroSerialization
描述如何串行化來自輸入的數據,或數據在以Avro格式寫入輸出時如何串行化。
名稱 | 類型 | Description |
---|---|---|
type |
string:
Avro |
指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。 |
AzureSqlReferenceInputDataSource
描述 Azure SQL 資料庫參考輸入數據源。
名稱 | 類型 | Description |
---|---|---|
properties.database |
string |
這個元素與 datasource 元素相關聯。 這是輸出將寫入的資料庫名稱。 |
properties.deltaSnapshotQuery |
string |
這個元素與 datasource 元素相關聯。 此查詢可用來從 SQL 資料庫擷取累加變更。 若要使用此選項,建議您在 Azure SQL Database 中使用時態表。 |
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) 要求上的必要專案。 |
BlobReferenceInputDataSource
描述包含參考數據的 Blob 輸入數據源。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
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 |
時間格式。 每當 pathPattern 中出現 {time} 時,這個屬性的值會改用為時間格式。 |
|
type |
string:
Microsoft. |
指出包含參考數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。 |
BlobStreamInputDataSource
描述包含數據流數據的 Blob 輸入數據源。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
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 |
時間格式。 每當 pathPattern 中出現 {time} 時,這個屬性的值會改用為時間格式。 |
|
type |
string:
Microsoft. |
指出包含數據流數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。 |
Compression
描述如何壓縮輸入數據
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
type | None |
指出輸入所使用的壓縮類型。 PUT (CreateOrReplace) 要求上的必要專案。 |
CompressionType
指出輸入所使用的壓縮類型。 PUT (CreateOrReplace) 要求上的必要專案。
名稱 | 類型 | Description |
---|---|---|
Deflate |
string |
|
GZip |
string |
|
None |
string |
CsvSerialization
描述如何串行化來自輸入的數據,或將數據以 CSV 格式寫入輸出時如何串行化。
名稱 | 類型 | Description |
---|---|---|
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
適用於需要客戶注意的資源或整體作業的條件。
名稱 | 類型 | Description |
---|---|---|
code |
string |
不透明診斷程序代碼。 |
message |
string |
描述條件的人類可讀訊息。 當地語系化為用戶端要求的 Accept-Language。 |
since |
string |
條件啟動時的 UTC 時間戳。 客戶此時應該能夠在作業記錄中找到對應的事件。 |
Diagnostics
描述可讓客戶注意的輸入、輸出或整體作業適用的條件。
名稱 | 類型 | Description |
---|---|---|
conditions |
適用於資源或整體作業的零個或多個條件集合,可讓客戶注意。 |
Encoding
指定輸入時的傳入數據的編碼方式,以及在輸出的情況下指定傳出數據的編碼方式。
名稱 | 類型 | Description |
---|---|---|
UTF8 |
string |
Error
常見的錯誤表示。
名稱 | 類型 | Description |
---|---|---|
error |
錯誤定義屬性。 |
EventHubStreamInputDataSource
描述包含數據流數據的事件中樞輸入數據源。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
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
描述包含數據流數據的事件中樞輸入數據源。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
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) 要求上的必要專案。
名稱 | 類型 | Description |
---|---|---|
Avro |
string |
|
Csv |
string |
|
Json |
string |
|
Parquet |
string |
FileReferenceInputDataSource
描述包含參考數據的檔案輸入數據源。
名稱 | 類型 | Description |
---|---|---|
properties.path |
string |
檔案的路徑。 |
type |
string:
File |
指出包含參考數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。 |
GatewayMessageBusStreamInputDataSource
描述包含數據流數據的 Blob 輸入數據源。
名稱 | 類型 | Description |
---|---|---|
properties.topic |
string |
服務總線主題的名稱。 |
type |
string:
Gateway |
指出包含數據流數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。 |
Input
輸入物件,包含與具名輸入相關聯的所有資訊。 所有輸入都包含在串流作業下。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼 |
name |
string |
資源名稱 |
properties | InputProperties: |
與輸入相關聯的屬性。 PUT (CreateOrReplace) 要求上的必要專案。 |
type |
string |
資源類型 |
IoTHubStreamInputDataSource
描述包含數據流數據的輸入數據來源 IoT 中樞。
名稱 | 類型 | Description |
---|---|---|
properties.consumerGroupName |
string |
應該用來從 IoT 中樞 讀取事件的 IoT 中樞 取用者群組名稱。 如果未指定,輸入會使用Iot 中樞的預設取用者群組。 |
properties.endpoint |
string |
要連線至 (的 IoT 中樞 端點,亦即訊息/事件、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) 要求上的必要專案。 |
JsonOutputSerializationFormat
指定輸出將寫入的 JSON 格式。 目前支援的值是 『lineSeparated』,表示輸出會藉由以新行分隔的每個 JSON 物件格式化,而 'array' 表示輸出會格式化為 JSON 物件的數位。
名稱 | 類型 | Description |
---|---|---|
Array |
string |
|
LineSeparated |
string |
JsonSerialization
描述如何串行化來自輸入的數據,或將數據以 JSON 格式寫入輸出時如何串行化數據。
名稱 | 類型 | Description |
---|---|---|
properties.encoding |
指定輸入時的傳入數據的編碼方式,以及在輸出的情況下指定傳出數據的編碼方式。 PUT (CreateOrReplace) 要求上的必要專案。 |
|
properties.format |
此屬性僅適用於輸出的 JSON 串行化。 它不適用於輸入。 此屬性會指定輸出將寫入的 JSON 格式。 目前支援的值是 『lineSeparated』,表示輸出會藉由以新行分隔的每個 JSON 物件格式化,而 'array' 表示輸出會格式化為 JSON 物件的數位。 如果保留 null,預設值為 'lineSeparated'。 |
|
type |
string:
Json |
指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。 |
ParquetSerialization
描述如何串行化來自輸入的數據,或數據在以 Parquet 格式寫入輸出時如何串行化。
名稱 | 類型 | Description |
---|---|---|
type |
string:
Parquet |
指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。 |
ReferenceInputProperties
與包含參考數據的輸入相關聯的屬性。
名稱 | 類型 | Description |
---|---|---|
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
指出數據重新整理選項的類型。
名稱 | 類型 | Description |
---|---|---|
RefreshPeriodicallyWithDelta |
string |
|
RefreshPeriodicallyWithFull |
string |
|
Static |
string |
StorageAccount
與 Azure 記憶體帳戶相關聯的屬性
名稱 | 類型 | Description |
---|---|---|
accountKey |
string |
Azure 記憶體帳戶的帳戶的帳戶金鑰。 PUT (CreateOrReplace) 要求上的必要專案。 |
accountName |
string |
Azure 儲存體帳戶的名稱。 PUT (CreateOrReplace) 要求上的必要專案。 |
StreamInputProperties
與包含數據流數據的輸入相關聯的屬性。
名稱 | 類型 | Description |
---|---|---|
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) 要求上的必要專案。 |