共用方式為


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

名稱 位於 必要 類型 Description
jobName
path True

string

串流作業的名稱。

resourceGroupName
path True

string

資源群組的名稱。 名稱不區分大小寫。

Regex 模式: ^[-\w\._\(\)]+$

subscriptionId
path True

string

目標訂用帳戶的標識碼。

api-version
query True

string

用於此作業的 API 版本。

要求標頭

名稱 必要 類型 Description
If-Match

string

串流作業的 ETag。 省略此值以一律覆寫目前的記錄集。 指定最後一個出現的 ETag 值,以防止意外覆寫並行變更。

If-None-Match

string

設定為 『*』 以允許建立新的串流作業,但為了避免更新現有的記錄集。 其他值會導致 412 前置條件失敗的回應。

要求本文

名稱 類型 Description
identity

Identity

描述指派給此作業的系統指派受控識別,可用來向輸入和輸出進行驗證。

location

string

資源所在的地理位置

properties.cluster

ClusterInfo

將執行串流作業的叢集。

properties.compatibilityLevel

CompatibilityLevel

控制串流處理工作的某些執行時間行為。

properties.contentStoragePolicy

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

EventsOutOfOrderPolicy

指出要套用至輸入事件串流中未按順序送達之事件的原則。

properties.functions

Function[]

串流作業的一或多個函式清單。 在 PUT 要求中指定此屬性時,需要每個函式的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別轉換的 PATCH API。

properties.inputs

Input[]

串流作業的一或多個輸入清單。 在 PUT 要求中指定此屬性時,需要每個輸入的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別輸入的 PATCH API。

properties.jobStorageAccount

JobStorageAccount

與具有 MSI 的 Azure 記憶體帳戶相關聯的屬性

properties.jobType

JobType

描述作業的類型。 有效的模式為 Cloud 和 『Edge』。

properties.outputErrorPolicy

OutputErrorPolicy

指出要套用至到達輸出且因格式錯誤 (遺失資料行值、資料行值的類型或大小錯誤) 而無法寫入外部儲存體之事件的原則。

properties.outputStartMode

OutputStartMode

只有在建立作業時,才應該立即使用這個屬性。 值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指出每當啟動作業時,輸出事件數據流的起點應該啟動、從透過 outputStartTime 屬性指定的自定義使用者時間戳開始,或從最後一個事件輸出時間開始。

properties.outputStartTime

string

值可以是 ISO 8601 格式的時間戳記 (代表輸出事件資料流的啟動點) 或 null (代表輸出事件資料流會在每次資料流工作啟動時啟動)。 如果 outputStartMode 設定為 CustomTime,此屬性必須有值。

properties.outputs

Output[]

串流作業的一或多個輸出清單。 在 PUT 要求中指定此屬性時,需要每個輸出的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別輸出的 PATCH API。

properties.sku

Sku

描述串流作業的 SKU。 PUT (CreateOrReplace) 要求上的必要專案。

properties.transformation

Transformation

指出要用於串流作業的查詢和串流單位數目。 在 PUT 要求中指定此屬性時,需要轉換的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別轉換的 PATCH API。

tags

object

資源標籤。

回應

名稱 類型 Description
200 OK

StreamingJob

已成功建立或取代串流作業。

標題

ETag: string

201 Created

StreamingJob

已成功建立或取代串流作業。

標題

ETag: string

Other Status Codes

Error

錯誤。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Create a complete streaming job (a streaming job with a transformation, at least 1 input and at least 1 output)
Create a streaming job shell (a streaming job with no inputs, outputs, transformation, or functions)

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": []
  }
}

定義

名稱 Description
AggregateFunctionProperties

與聚合函數相關聯的屬性。

AuthenticationMode

驗證模式。 有效的模式為 ConnectionStringMsi 和 『UserToken』。

AvroSerialization

描述如何串行化來自輸入的數據,或在以Avro格式寫入輸出時如何串行化數據。

AzureDataLakeStoreOutputDataSource

描述 Azure Data Lake Store 輸出數據源。

AzureFunctionOutputDataSource

定義 AzureFunctionOutputDataSource 的元數據

AzureMachineLearningWebServiceFunctionBinding

系結至 Azure Machine Learning Web 服務。

AzureMachineLearningWebServiceInputColumn

描述 Azure Machine Learning Web 服務端點的輸入數據行。

AzureMachineLearningWebServiceInputs

Azure Machine Learning Web 服務端點的輸入。

AzureMachineLearningWebServiceOutputColumn

描述 Azure Machine Learning Web 服務端點的輸出數據行。

AzureSqlDatabaseOutputDataSource

描述 Azure SQL 資料庫輸出數據源。

AzureSqlReferenceInputDataSource

描述 Azure SQL 資料庫參考輸入數據源。

AzureSynapseOutputDataSource

描述輸出數據源 Azure Synapse。

AzureTableOutputDataSource

描述 Azure 資料表輸出數據來源。

BlobOutputDataSource

描述 Blob 輸出數據來源。

BlobReferenceInputDataSource

描述包含參考數據的 Blob 輸入數據源。

BlobStreamInputDataSource

描述包含數據流數據的 Blob 輸入數據源。

ClusterInfo

與串流分析叢集相關聯的屬性。

CompatibilityLevel

控制串流處理工作的某些執行時間行為。

Compression

描述如何壓縮輸入數據

CompressionType

指出輸入所使用的壓縮類型。 PUT (CreateOrReplace) 要求上的必要專案。

ContentStoragePolicy

有效值為JobStorageAccount和 SystemAccount。 如果設定為 JobStorageAccount,這需要用戶同時指定 jobStorageAccount 屬性。 .

CsvSerialization

描述如何串行化來自輸入的數據,或以 CSV 格式寫入輸出時如何串行化數據。

DiagnosticCondition

適用於資源或整體作業的條件,這需要客戶注意。

Diagnostics

描述適用於需要客戶注意之輸入、輸出或整體作業的條件。

DocumentDbOutputDataSource

描述 DocumentDB 輸出數據源。

Encoding

指定輸入時的傳入數據的編碼方式,以及在輸出的情況下指定傳出數據的編碼方式。

Error

常見的錯誤表示。

EventHubOutputDataSource

描述事件中樞輸出數據源。

EventHubStreamInputDataSource

描述包含數據流數據的事件中樞輸入數據源。

EventHubV2OutputDataSource

描述事件中樞輸出數據源。

EventHubV2StreamInputDataSource

描述包含數據流數據的事件中樞輸入數據源。

EventSerializationType

指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。

EventsOutOfOrderPolicy

指出要套用至輸入事件串流中未按順序送達之事件的原則。

FileReferenceInputDataSource

描述包含參考數據的檔案輸入數據源。

Function

函式物件,包含與具名函式相關聯的所有資訊。 所有函式都包含在串流作業之下。

FunctionInput

描述函式的一個輸入參數。

FunctionOutput

描述函式的輸出。

GatewayMessageBusOutputDataSource

描述閘道訊息總線輸出數據來源。

GatewayMessageBusStreamInputDataSource

描述包含數據流數據的 Blob 輸入數據源。

Identity

描述如何驗證身分識別

Input

輸入物件,包含與具名輸入相關聯的所有資訊。 所有輸入都包含在串流作業之下。

IoTHubStreamInputDataSource

描述包含數據流數據的 IoT 中樞 輸入數據源。

JavaScriptFunctionBinding

JavaScript 函式的系結。

JobStorageAccount

與具有 MSI 的 Azure 記憶體帳戶相關聯的屬性

JobType

描述作業的類型。 有效的模式為 Cloud 和 『Edge』。

JsonOutputSerializationFormat

指定將寫入輸出的 JSON 格式。 目前支援的值是 『lineSeparated』,表示輸出會格式化,方法是讓每個 JSON 物件以新行分隔,而 『array』 表示輸出會格式化為 JSON 物件的陣列。

JsonSerialization

描述如何串行化來自輸入的數據,或以 JSON 格式寫入輸出時如何串行化數據。

Output

輸出物件,包含與具名輸出相關聯的所有資訊。 所有輸出都包含在串流作業下。

OutputErrorPolicy

指出要套用至到達輸出且因格式錯誤 (遺失資料行值、資料行值的類型或大小錯誤) 而無法寫入外部儲存體之事件的原則。

OutputStartMode

值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指出每當啟動作業時,輸出事件數據流的起點應該啟動、從透過 outputStartTime 屬性指定的自定義使用者時間戳開始,或從最後一個事件輸出時間開始。

ParquetSerialization

描述如何串行化來自輸入的數據,或在以 Parquet 格式寫入輸出時如何串行化數據。

PowerBIOutputDataSource

描述 Power BI 輸出數據來源。

ReferenceInputProperties

與包含參考數據的輸入相關聯的屬性。

RefreshType

指出數據重新整理選項的類型。

ScalarFunctionProperties

與純量函式相關聯的屬性。

ServiceBusQueueOutputDataSource

描述服務總線佇列輸出數據源。

ServiceBusTopicOutputDataSource

描述服務總線主題輸出數據源。

Sku

與 SKU 相關聯的屬性。

SkuName

SKU 的名稱。 PUT (CreateOrReplace) 要求上的必要專案。

StorageAccount

與 Azure 記憶體帳戶相關聯的屬性

StreamingJob

串流作業物件,包含與具名串流作業相關聯的所有資訊。

StreamInputProperties

與包含數據流數據的輸入相關聯的屬性。

Transformation

轉換物件,包含與具名轉換相關聯的所有資訊。 所有轉換都包含在串流作業之下。

AggregateFunctionProperties

與聚合函數相關聯的屬性。

名稱 類型 Description
etag

string

函式的目前實體標籤。 這是不透明的字串。 您可以使用它來偵測資源是否在要求之間變更。 您也可以在 If-Match 或 If-None-Match 標頭中使用它,以進行開放式並行存取的寫入作業。

properties.binding FunctionBinding:

函式的實體系結。 例如,在 Azure Machine Learning Web 服務的案例中,這會描述端點。

properties.inputs

FunctionInput[]

描述函式的一個輸入參數。

properties.output

FunctionOutput

描述函式的輸出。

type string:

Aggregate

表示函式的類型。

AuthenticationMode

驗證模式。 有效的模式為 ConnectionStringMsi 和 『UserToken』。

名稱 類型 Description
ConnectionString

string

Msi

string

UserToken

string

AvroSerialization

描述如何串行化來自輸入的數據,或在以Avro格式寫入輸出時如何串行化數據。

名稱 類型 Description
type string:

Avro

指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。

AzureDataLakeStoreOutputDataSource

描述 Azure Data Lake Store 輸出數據源。

名稱 類型 預設值 Description
properties.accountName

string

Azure Data Lake Store 帳戶的名稱。 PUT (CreateOrReplace) 要求上的必要專案。

properties.authenticationMode

AuthenticationMode

ConnectionString

驗證模式。

properties.dateFormat

string

日期格式。 無論 {date} 出現在 filePathPrefix 的位置,此屬性的值會改用為日期格式。

properties.filePathPrefix

string

輸出應該寫入其中的檔案位置。 PUT (CreateOrReplace) 要求上的必要專案。

properties.refreshToken

string

重新整理令牌,可用來取得有效的存取令牌,然後可用來向數據源進行驗證。 有效的重新整理令牌目前只能透過 Azure 入口網站取得。 建議您在建立數據源時將虛擬字串值放在此處,然後移至 Azure 入口網站來驗證數據源,以有效重新整理令牌更新此屬性。 PUT (CreateOrReplace) 要求上的必要專案。

properties.tenantId

string

用來取得重新整理令牌之使用者的租用戶標識碼。 PUT (CreateOrReplace) 要求上的必要專案。

properties.timeFormat

string

時間格式。 無論 {time} 出現在 filePathPrefix 的位置,此屬性的值會改用為時間格式。

properties.tokenUserDisplayName

string

用來取得重新整理令牌之用戶的用戶顯示名稱。 使用此屬性可協助記住用來取得重新整理令牌的使用者。

properties.tokenUserPrincipalName

string

用來取得重新整理令牌的用戶主體名稱 (UPN) 。 使用此屬性可協助記住用來取得重新整理令牌的使用者。

type string:

Microsoft.DataLake/Accounts

指出將寫入數據源輸出的類型。 PUT (CreateOrReplace) 要求上的必要專案。

AzureFunctionOutputDataSource

定義 AzureFunctionOutputDataSource 的元數據

名稱 類型 Description
properties.apiKey

string

如果您想要使用另一個訂用帳戶中的 Azure Function,可以藉由提供存取函式的金鑰來達到這個目的。

properties.functionAppName

string

Azure Functions 應用程式的名稱。

properties.functionName

string

Azure Functions 應用程式中函式的名稱。

properties.maxBatchCount

number

屬性可讓您在傳送至 Azure Functions 的每個批次中,指定事件數目上限。 預設值是 100。

properties.maxBatchSize

number

屬性可讓您針對傳送到您 Azure Function 的每個輸出批次,設定大小上限。 輸入是以位元組為單位。 根據預設,此值是 262,144 個位元組 (256 KB)。

type string:

Microsoft.AzureFunction

指出將寫入數據源輸出的類型。 PUT (CreateOrReplace) 要求上的必要專案。

AzureMachineLearningWebServiceFunctionBinding

系結至 Azure Machine Learning Web 服務。

名稱 類型 Description
properties.apiKey

string

用來向 Request-Response 端點進行驗證的 API 金鑰。

properties.batchSize

integer

描述每個 Azure ML RRS 執行要求的數據列數目上限,介於 1 到 10000 之間。 預設值為 1000。

properties.endpoint

string

Request-Response Azure Machine Learning Web 服務的端點。 在這裡深入瞭解: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs

properties.inputs

AzureMachineLearningWebServiceInputs

Azure Machine Learning Web 服務端點的輸入。

properties.outputs

AzureMachineLearningWebServiceOutputColumn[]

Azure Machine Learning Web 服務端點執行的輸出清單。

type string:

Microsoft.MachineLearning/WebService

表示函式系結類型。

AzureMachineLearningWebServiceInputColumn

描述 Azure Machine Learning Web 服務端點的輸入數據行。

名稱 類型 Description
dataType

string

(Azure Machine Learning 支援) 輸入數據行的數據類型。 有效的 Azure Machine Learning 資料類型清單說明於 https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx

mapTo

integer

這個輸入對應至之函式參數之以零起始的索引。

name

string

輸入資料行的名稱。

AzureMachineLearningWebServiceInputs

Azure Machine Learning Web 服務端點的輸入。

名稱 類型 Description
columnNames

AzureMachineLearningWebServiceInputColumn[]

Azure Machine Learning Web 服務端點的輸入數據行清單。

name

string

輸入的名稱。 這是撰寫端點時提供的名稱。

AzureMachineLearningWebServiceOutputColumn

描述 Azure Machine Learning Web 服務端點的輸出數據行。

名稱 類型 Description
dataType

string

(Azure Machine Learning 支援的輸出資料行) 資料類型。 有效的 Azure Machine Learning 資料類型清單說明於 https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx

name

string

輸出資料行的名稱。

AzureSqlDatabaseOutputDataSource

描述 Azure SQL 資料庫輸出數據源。

名稱 類型 預設值 Description
properties.authenticationMode

AuthenticationMode

ConnectionString

驗證模式。

properties.database

string

Azure SQL 資料庫的名稱。 PUT (CreateOrReplace) 要求上的必要專案。

properties.maxBatchCount

number

寫入 Sql 資料庫的 Batch 計數上限,預設值為 10,000。 PUT 要求的選擇性。

properties.maxWriterCount

number

最大寫入器計數,目前只有 1 個 (單一寫入器) 和 0 個以查詢分割區) 為基礎的 (。 PUT 要求的選擇性。

properties.password

string

將用來連線至 Azure SQL 資料庫的密碼。 PUT (CreateOrReplace) 要求上的必要專案。

properties.server

string

包含 Azure SQL 資料庫的 SQL Server 名稱。 PUT (CreateOrReplace) 要求上的必要專案。

properties.table

string

Azure SQL 資料庫中數據表的名稱。 PUT (CreateOrReplace) 要求上的必要專案。

properties.user

string

將用來連接到 Azure SQL 資料庫的用戶名稱。 PUT (CreateOrReplace) 要求上的必要專案。

type string:

Microsoft.Sql/Server/Database

指出將寫入數據源輸出的類型。 PUT (CreateOrReplace) 要求上的必要專案。

AzureSqlReferenceInputDataSource

描述 Azure SQL 資料庫參考輸入數據源。

名稱 類型 Description
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

RefreshType

指出數據重新整理選項的類型。

properties.server

string

這個元素與 datasource 元素相關聯。 這是伺服器的名稱,包含將寫入的資料庫。

properties.table

string

這個元素與 datasource 元素相關聯。 Azure SQL 資料庫中的數據表名稱。

properties.user

string

這個元素與 datasource 元素相關聯。 這是將用來連接到 SQL Database 執行個體的使用者名稱。

type string:

Microsoft.Sql/Server/Database

指出包含參考數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

AzureSynapseOutputDataSource

描述輸出數據源 Azure Synapse。

名稱 類型 Description
properties.database

string

Azure SQL 資料庫的名稱。 PUT (CreateOrReplace) 要求上的必要專案。

properties.password

string

將用來連線至 Azure SQL 資料庫的密碼。 PUT (CreateOrReplace) 要求上的必要專案。

properties.server

string

包含 Azure SQL 資料庫的 SQL Server 名稱。 PUT (CreateOrReplace) 要求上的必要專案。

properties.table

string

Azure SQL 資料庫中數據表的名稱。 PUT (CreateOrReplace) 要求上的必要專案。

properties.user

string

將用來連接到 Azure SQL 資料庫的用戶名稱。 PUT (CreateOrReplace) 要求上的必要專案。

type string:

Microsoft.Sql/Server/DataWarehouse

指出將寫入數據源輸出的類型。 PUT (CreateOrReplace) 要求上的必要專案。

AzureTableOutputDataSource

描述 Azure 資料表輸出數據來源。

名稱 類型 Description
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.Storage/Table

指出將寫入數據源輸出的類型。 PUT (CreateOrReplace) 要求上的必要專案。

BlobOutputDataSource

描述 Blob 輸出數據來源。

名稱 類型 預設值 Description
properties.authenticationMode

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-inputhttps://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output

properties.storageAccounts

StorageAccount[]

一或多個 Azure 記憶體帳戶的清單。 PUT (CreateOrReplace) 要求上的必要專案。

properties.timeFormat

string

時間格式。 無論 {time} 出現在 pathPattern 中,此屬性的值會改用為時間格式。

type string:

Microsoft.Storage/Blob

指出將寫入數據源輸出的類型。 PUT (CreateOrReplace) 要求上的必要專案。

BlobReferenceInputDataSource

描述包含參考數據的 Blob 輸入數據源。

名稱 類型 預設值 Description
properties.authenticationMode

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-inputhttps://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output

properties.storageAccounts

StorageAccount[]

一或多個 Azure 記憶體帳戶的清單。 PUT (CreateOrReplace) 要求上的必要專案。

properties.timeFormat

string

時間格式。 無論 {time} 出現在 pathPattern 中,此屬性的值會改用為時間格式。

type string:

Microsoft.Storage/Blob

指出包含參考數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

BlobStreamInputDataSource

描述包含數據流數據的 Blob 輸入數據源。

名稱 類型 預設值 Description
properties.authenticationMode

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-inputhttps://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output

properties.sourcePartitionCount

integer

Blob 輸入數據源的數據分割計數。 範圍 1 - 1024。

properties.storageAccounts

StorageAccount[]

一或多個 Azure 記憶體帳戶的清單。 PUT (CreateOrReplace) 要求上的必要專案。

properties.timeFormat

string

時間格式。 無論 {time} 出現在 pathPattern 中,此屬性的值會改用為時間格式。

type string:

Microsoft.Storage/Blob

指出包含數據流數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

ClusterInfo

與串流分析叢集相關聯的屬性。

名稱 類型 Description
id

string

叢集的資源標識碼。

CompatibilityLevel

控制串流處理工作的某些執行時間行為。

名稱 類型 Description
1.0

string

1.2

string

Compression

描述如何壓縮輸入數據

名稱 類型 預設值 Description
type

CompressionType

None

指出輸入所使用的壓縮類型。 PUT (CreateOrReplace) 要求上的必要專案。

CompressionType

指出輸入所使用的壓縮類型。 PUT (CreateOrReplace) 要求上的必要專案。

名稱 類型 Description
Deflate

string

GZip

string

None

string

ContentStoragePolicy

有效值為JobStorageAccount和 SystemAccount。 如果設定為 JobStorageAccount,這需要用戶同時指定 jobStorageAccount 屬性。 .

名稱 類型 Description
JobStorageAccount

string

SystemAccount

string

CsvSerialization

描述如何串行化來自輸入的數據,或以 CSV 格式寫入輸出時如何串行化數據。

名稱 類型 Description
properties.encoding

Encoding

指定輸入時的傳入數據的編碼方式,以及在輸出的情況下指定傳出數據的編碼方式。 PUT (CreateOrReplace) 要求上的必要專案。

properties.fieldDelimiter

string

指定分隔符,用來分隔 CSV) 記錄 (逗號分隔值。 如需支援的值清單,請參閱 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-inputhttps://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

DiagnosticCondition[]

零或多個條件的集合,適用於資源或整體作業,這需要客戶注意。

DocumentDbOutputDataSource

描述 DocumentDB 輸出數據源。

名稱 類型 Description
properties.accountId

string

DocumentDB 帳戶名稱或標識碼。 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.Storage/DocumentDB

指出將寫入數據源輸出的類型。 PUT (CreateOrReplace) 要求上的必要專案。

Encoding

指定輸入時的傳入數據的編碼方式,以及在輸出的情況下指定傳出數據的編碼方式。

名稱 類型 Description
UTF8

string

Error

常見的錯誤表示。

名稱 類型 Description
error

Error

錯誤定義屬性。

EventHubOutputDataSource

描述事件中樞輸出數據源。

名稱 類型 預設值 Description
authenticationMode

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.ServiceBus/EventHub

指出將寫入數據源輸出的類型。 PUT (CreateOrReplace) 要求上的必要專案。

EventHubStreamInputDataSource

描述包含數據流數據的事件中樞輸入數據源。

名稱 類型 預設值 Description
authenticationMode

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.ServiceBus/EventHub

指出包含數據流數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

EventHubV2OutputDataSource

描述事件中樞輸出數據源。

名稱 類型 預設值 Description
authenticationMode

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.EventHub/EventHub

指出將寫入數據源輸出的類型。 PUT (CreateOrReplace) 要求上的必要專案。

EventHubV2StreamInputDataSource

描述包含數據流數據的事件中樞輸入數據源。

名稱 類型 預設值 Description
authenticationMode

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.EventHub/EventHub

指出包含數據流數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

EventSerializationType

指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。

名稱 類型 Description
Avro

string

Csv

string

Json

string

Parquet

string

EventsOutOfOrderPolicy

指出要套用至輸入事件串流中未按順序送達之事件的原則。

名稱 類型 Description
Adjust

string

Drop

string

FileReferenceInputDataSource

描述包含參考數據的檔案輸入數據源。

名稱 類型 Description
properties.path

string

檔案的路徑。

type string:

File

指出包含參考數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

Function

函式物件,包含與具名函式相關聯的所有資訊。 所有函式都包含在串流作業之下。

名稱 類型 Description
id

string

資源標識碼

name

string

資源名稱

properties FunctionProperties:

與函式相關聯的屬性。

type

string

資源類型

FunctionInput

描述函式的一個輸入參數。

名稱 類型 Description
dataType

string

(Azure 串流分析支援函式輸入參數的) 資料類型。 以下說明有效的 Azure 串流分析資料類型清單 https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx

isConfigurationParameter

boolean

旗標,指出參數是否為組態參數。 如果這個輸入參數必須是常數,則為 True。 預設值為 false。

FunctionOutput

描述函式的輸出。

名稱 類型 Description
dataType

string

(Azure 串流分析支援的函式輸出) 資料類型。 以下說明有效的 Azure 串流分析資料類型清單 https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx

GatewayMessageBusOutputDataSource

描述閘道訊息總線輸出數據來源。

名稱 類型 Description
properties.topic

string

服務總線主題的名稱。

type string:

GatewayMessageBus

指出將寫入數據源輸出的類型。 PUT (CreateOrReplace) 要求上的必要專案。

GatewayMessageBusStreamInputDataSource

描述包含數據流數據的 Blob 輸入數據源。

名稱 類型 Description
properties.topic

string

服務總線主題的名稱。

type string:

GatewayMessageBus

指出包含數據流數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

Identity

描述如何驗證身分識別

名稱 類型 Description
principalId

string

身分識別主體標識碼

tenantId

string

身分識別 tenantId

type

string

身分識別類型

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 中樞 端點,例如訊息/事件、訊息/operationsMonitoringEvents 等 ) 。

properties.iotHubNamespace

string

IoT 中樞 的名稱或 URI。 PUT (CreateOrReplace) 要求上的必要專案。

properties.sharedAccessPolicyKey

string

指定之共用存取原則的共用存取原則金鑰。 PUT (CreateOrReplace) 要求上的必要專案。

properties.sharedAccessPolicyName

string

IoT 中樞 的共用存取原則名稱。 此原則至少必須包含服務連線許可權。 PUT (CreateOrReplace) 要求上的必要專案。

type string:

Microsoft.Devices/IotHubs

指出包含數據流數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

JavaScriptFunctionBinding

JavaScript 函式的系結。

名稱 類型 Description
properties.script

string

包含單一函式定義的 JavaScript 程式代碼。 例如:'function (x, y) { return x + y; }'

type string:

Microsoft.StreamAnalytics/JavascriptUdf

表示函式系結類型。

JobStorageAccount

與具有 MSI 的 Azure 記憶體帳戶相關聯的屬性

名稱 類型 預設值 Description
accountKey

string

Azure 記憶體帳戶的帳戶的帳戶金鑰。 PUT (CreateOrReplace) 要求上的必要專案。

accountName

string

Azure 儲存體帳戶的名稱。 PUT (CreateOrReplace) 要求上的必要專案。

authenticationMode

AuthenticationMode

ConnectionString

驗證模式。

JobType

描述作業的類型。 有效的模式為 Cloud 和 『Edge』。

名稱 類型 Description
Cloud

string

Edge

string

JsonOutputSerializationFormat

指定將寫入輸出的 JSON 格式。 目前支援的值是 『lineSeparated』,表示輸出會格式化,方法是讓每個 JSON 物件以新行分隔,而 『array』 表示輸出會格式化為 JSON 物件的陣列。

名稱 類型 Description
Array

string

LineSeparated

string

JsonSerialization

描述如何串行化來自輸入的數據,或以 JSON 格式寫入輸出時如何串行化數據。

名稱 類型 Description
properties.encoding

Encoding

指定輸入時的傳入數據的編碼方式,以及在輸出的情況下指定傳出數據的編碼方式。 PUT (CreateOrReplace) 要求上的必要專案。

properties.format

JsonOutputSerializationFormat

此屬性僅適用於輸出的 JSON 串行化。 不適用於輸入。 此屬性會指定輸出將寫入的 JSON 格式。 目前支援的值是 『lineSeparated』,表示輸出會格式化,方法是讓每個 JSON 物件以新行分隔,而 『array』 表示輸出會格式化為 JSON 物件的陣列。 如果保留 null,預設值為 'lineSeparated'。

type string:

Json

指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。

Output

輸出物件,包含與具名輸出相關聯的所有資訊。 所有輸出都包含在串流作業下。

名稱 類型 Description
id

string

資源標識碼

name

string

資源名稱

properties.datasource OutputDataSource:

描述將寫入輸出的數據源。 PUT (CreateOrReplace) 要求上的必要專案。

properties.diagnostics

Diagnostics

描述適用於需要客戶注意之輸入、輸出或整體作業的條件。

properties.etag

string

輸出的目前實體標籤。 這是不透明的字串。 您可以使用它來偵測資源是否在要求之間變更。 您也可以在 If-Match 或 If-None-Match 標頭中使用它,以進行開放式並行存取的寫入作業。

properties.serialization Serialization:

描述如何串行化來自輸入的數據,或將數據寫入輸出時如何串行化。 PUT (CreateOrReplace) 要求上的必要專案。

properties.sizeWindow

integer

要限制串流分析輸出的大小視窗。

properties.timeWindow

string

篩選串流分析作業輸出的時間範圍。

type

string

資源類型

OutputErrorPolicy

指出要套用至到達輸出且因格式錯誤 (遺失資料行值、資料行值的類型或大小錯誤) 而無法寫入外部儲存體之事件的原則。

名稱 類型 Description
Drop

string

Stop

string

OutputStartMode

值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指出每當啟動作業時,輸出事件數據流的起點應該啟動、從透過 outputStartTime 屬性指定的自定義使用者時間戳開始,或從最後一個事件輸出時間開始。

名稱 類型 Description
CustomTime

string

JobStartTime

string

LastOutputEventTime

string

ParquetSerialization

描述如何串行化來自輸入的數據,或在以 Parquet 格式寫入輸出時如何串行化數據。

名稱 類型 Description
type string:

Parquet

指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。

PowerBIOutputDataSource

描述 Power BI 輸出數據來源。

名稱 類型 預設值 Description
properties.authenticationMode

AuthenticationMode

ConnectionString

驗證模式。

properties.dataset

string

Power BI 資料集的名稱。 PUT (CreateOrReplace) 要求上的必要專案。

properties.groupId

string

Power BI 群組的標識碼。

properties.groupName

string

Power BI 群組的名稱。 使用這個屬性可協助記住已使用哪些特定的Power BI群組標識碼。

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

與包含參考數據的輸入相關聯的屬性。

名稱 類型 Description
compression

Compression

描述如何壓縮輸入數據

datasource ReferenceInputDataSource:

描述包含參考數據的輸入數據來源。 PUT (CreateOrReplace) 要求上的必要專案。

diagnostics

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

ScalarFunctionProperties

與純量函式相關聯的屬性。

名稱 類型 Description
etag

string

函式的目前實體標籤。 這是不透明的字串。 您可以使用它來偵測資源是否在要求之間變更。 您也可以在 If-Match 或 If-None-Match 標頭中使用它,以進行開放式並行存取的寫入作業。

properties.binding FunctionBinding:

函式的實體系結。 例如,在 Azure Machine Learning Web 服務的案例中,這會描述端點。

properties.inputs

FunctionInput[]

描述函式的一個輸入參數。

properties.output

FunctionOutput

描述函式的輸出。

type string:

Scalar

表示函式的類型。

ServiceBusQueueOutputDataSource

描述服務總線佇列輸出數據源。

名稱 類型 預設值 Description
properties.authenticationMode

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.ServiceBus/Queue

指出將寫入數據源輸出的類型。 PUT (CreateOrReplace) 要求上的必要專案。

ServiceBusTopicOutputDataSource

描述服務總線主題輸出數據源。

名稱 類型 預設值 Description
properties.authenticationMode

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.ServiceBus/Topic

指出將寫入數據源輸出的類型。 PUT (CreateOrReplace) 要求上的必要專案。

Sku

與 SKU 相關聯的屬性。

名稱 類型 Description
name

SkuName

SKU 的名稱。 PUT (CreateOrReplace) 要求上的必要專案。

SkuName

SKU 的名稱。 PUT (CreateOrReplace) 要求上的必要專案。

名稱 類型 Description
Standard

string

StorageAccount

與 Azure 記憶體帳戶相關聯的屬性

名稱 類型 Description
accountKey

string

Azure 記憶體帳戶的帳戶的帳戶金鑰。 PUT (CreateOrReplace) 要求上的必要專案。

accountName

string

Azure 儲存體帳戶的名稱。 PUT (CreateOrReplace) 要求上的必要專案。

StreamingJob

串流作業物件,包含與具名串流作業相關聯的所有資訊。

名稱 類型 Description
id

string

資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

描述指派給此作業的系統指派受控識別,可用來向輸入和輸出進行驗證。

location

string

資源所在的地理位置

name

string

資源的名稱

properties.cluster

ClusterInfo

將執行串流作業的叢集。

properties.compatibilityLevel

CompatibilityLevel

控制串流處理工作的某些執行時間行為。

properties.contentStoragePolicy

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

EventsOutOfOrderPolicy

指出要套用至輸入事件串流中未按順序送達之事件的原則。

properties.functions

Function[]

串流作業的一或多個函式清單。 在 PUT 要求中指定此屬性時,需要每個函式的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別轉換的 PATCH API。

properties.inputs

Input[]

串流作業的一或多個輸入清單。 在 PUT 要求中指定此屬性時,需要每個輸入的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別輸入的 PATCH API。

properties.jobId

string

GUID 可唯一識別串流作業。 建立串流作業時會產生此 GUID。

properties.jobState

string

描述串流作業的狀態。

properties.jobStorageAccount

JobStorageAccount

與具有 MSI 的 Azure 記憶體帳戶相關聯的屬性

properties.jobType

JobType

描述作業的類型。 有效的模式為 Cloud 和 『Edge』。

properties.lastOutputEventTime

string

值是 ISO-8601 格式時間戳,指出串流作業的最後一個輸出事件時間,或表示尚未產生輸出的 Null。 如果是多個輸出或多個數據流,這會顯示該集合中的最新值。

properties.outputErrorPolicy

OutputErrorPolicy

指出要套用至到達輸出且因格式錯誤 (遺失資料行值、資料行值的類型或大小錯誤) 而無法寫入外部儲存體之事件的原則。

properties.outputStartMode

OutputStartMode

只有在建立作業時,才應該立即使用這個屬性。 值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指出每當啟動作業時,輸出事件數據流的起點應該啟動、從透過 outputStartTime 屬性指定的自定義使用者時間戳開始,或從最後一個事件輸出時間開始。

properties.outputStartTime

string

值可以是 ISO 8601 格式的時間戳記 (代表輸出事件資料流的啟動點) 或 null (代表輸出事件資料流會在每次資料流工作啟動時啟動)。 如果 outputStartMode 設定為 CustomTime,此屬性必須有值。

properties.outputs

Output[]

串流作業的一或多個輸出清單。 在 PUT 要求中指定此屬性時,需要每個輸出的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別輸出的 PATCH API。

properties.provisioningState

string

描述串流作業的布建狀態。

properties.sku

Sku

描述串流作業的 SKU。 PUT (CreateOrReplace) 要求上的必要專案。

properties.transformation

Transformation

指出要用於串流作業的查詢和串流單位數目。 在 PUT 要求中指定此屬性時,需要轉換的名稱屬性。 此屬性無法透過 PATCH 作業進行修改。 您必須使用可用於個別轉換的 PATCH API。

tags

object

資源標籤。

type

string

資源類型。 Ex- Microsoft.Compute/virtualMachines 或 Microsoft.Storage/storageAccounts。

StreamInputProperties

與包含數據流數據的輸入相關聯的屬性。

名稱 類型 Description
compression

Compression

描述如何壓縮輸入數據

datasource StreamInputDataSource:

描述包含數據流數據的輸入數據來源。 PUT (CreateOrReplace) 要求上的必要專案。

diagnostics

Diagnostics

描述適用於需要客戶注意之輸入、輸出或整體作業的條件。

etag

string

輸入的目前實體標籤。 這是不透明的字串。 您可以使用它來偵測資源是否在要求之間變更。 您也可以在 If-Match 或 If-None-Match 標頭中使用它,以進行開放式並行存取的寫入作業。

partitionKey

string

partitionKey 描述輸入數據中的索引鍵,用於分割輸入數據

serialization Serialization:

描述如何串行化來自輸入的數據,或將數據寫入輸出時如何串行化。 PUT (CreateOrReplace) 要求上的必要專案。

type string:

Stream

指出輸入是參考數據的來源或數據流數據。 PUT (CreateOrReplace) 要求上的必要專案。

Transformation

轉換物件,包含與具名轉換相關聯的所有資訊。 所有轉換都包含在串流作業之下。

名稱 類型 預設值 Description
id

string

資源標識碼

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

資源類型