Streaming Jobs - List By Resource Group

列出指定資源群組中的所有串流作業。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs?api-version=2016-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs?$expand={$expand}&api-version=2016-03-01

URI 參數

Name In Required Type Description
resourceGroupName
path True
  • string

包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。

subscriptionId
path True
  • string

可唯一識別 Microsoft Azure 訂用帳戶的 GUID。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

api-version
query True
  • string

用戶端 Api 版本。

$expand
query
  • string

$Expand OData 查詢參數。 這是要包含在回應中的其他串流作業屬性清單(以逗號分隔),超過此參數不存在時所傳回的預設集合。 預設設定為「輸入」、「轉換」、「輸出」和「函式」以外的所有串流作業屬性。

回應

Name Type Description
200 OK

已成功列出指定資源群組下的串流作業。

Other Status Codes

錯誤。

安全性

azure_auth

Azure Active Directory OAuth2 流程

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模擬您的使用者帳戶

範例

List all streaming jobs in a resource group and do not use the $expand OData query parameter
List all streaming jobs in a resource group and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions

List all streaming jobs in a resource group and do not use the $expand OData query parameter

Sample Request

GET https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs?api-version=2016-03-01

Sample Response

{
  "value": [
    {
      "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": 21,
        "eventsLateArrivalMaxDelayInSeconds": 13,
        "dataLocale": "en-US",
        "createdDate": "2017-05-11T04:37:04.697Z",
        "compatibilityLevel": "1.0",
        "etag": "3e6872bc-c9d0-45b6-91b6-da66f1773056"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj69",
      "name": "sj69",
      "type": "Microsoft.StreamAnalytics/streamingjobs",
      "location": "West US",
      "tags": {
        "key1": "value1",
        "randomKey": "randomValue",
        "key3": "value3"
      },
      "properties": {
        "sku": {
          "name": "Standard"
        },
        "jobId": "817b36cf-a161-4a9e-86f2-eb00b3566d88",
        "provisioningState": "Succeeded",
        "jobState": "Created",
        "eventsOutOfOrderPolicy": "Drop",
        "outputErrorPolicy": "Drop",
        "eventsOutOfOrderMaxDelayInSeconds": 5,
        "eventsLateArrivalMaxDelayInSeconds": 6,
        "dataLocale": "en-US",
        "createdDate": "2017-05-11T04:38:04.697Z",
        "compatibilityLevel": "1.0",
        "etag": "99538949-a164-4e2f-a991-40303e86024f"
      }
    }
  ]
}

List all streaming jobs in a resource group and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions

Sample Request

GET https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs?$expand=inputs,outputs,transformation,functions&api-version=2016-03-01

Sample Response

{
  "value": [
    {
      "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": "Adjust",
        "outputErrorPolicy": "Stop",
        "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": "8081b2a3-dfe6-457f-8740-1a22d209bf8a"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7805",
      "name": "sj7805",
      "type": "Microsoft.StreamAnalytics/streamingjobs",
      "location": "West US",
      "tags": {
        "key1": "value1",
        "randomKey": "randomValue",
        "key3": "value3"
      },
      "properties": {
        "sku": {
          "name": "Standard"
        },
        "jobId": "d8f4041a-0793-433e-a38d-5499d5332113",
        "provisioningState": "Succeeded",
        "jobState": "Created",
        "eventsOutOfOrderPolicy": "Adjust",
        "outputErrorPolicy": "Stop",
        "eventsOutOfOrderMaxDelayInSeconds": 0,
        "eventsLateArrivalMaxDelayInSeconds": 5,
        "dataLocale": "en-US",
        "createdDate": "2017-05-11T04:38: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": "45dcf40f-88bb-4776-b5ca-7b10a607cb59"
            }
          }
        ],
        "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": "288d95c0-204b-4c54-828f-f57aa6896b2a"
          }
        },
        "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": "b09606c8-1b0d-43c9-affb-fac0e18b9481"
            }
          }
        ],
        "etag": "5420059f-e5d7-47d4-be44-40816a4dca7e"
      }
    }
  ]
}

定義

AvroSerialization

描述如何序列化輸入中的資料,或將資料寫入 Avro 格式的輸出時如何序列化。

AzureDataLakeStoreOutputDataSource

描述 Azure Data Lake 儲存輸出資料來源。

AzureMachineLearningWebServiceFunctionBinding

Azure Machine Learning web 服務的系結。

AzureMachineLearningWebServiceInputColumn

描述 Azure Machine Learning web 服務端點的輸入資料行。

AzureMachineLearningWebServiceInputs

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

AzureMachineLearningWebServiceOutputColumn

描述 Azure Machine Learning web 服務端點的輸出資料行。

AzureSqlDatabaseOutputDataSource

描述 Azure SQL database 輸出資料來源。

AzureTableOutputDataSource

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

BlobOutputDataSource

描述 blob 輸出資料來源。

BlobReferenceInputDataSource

描述包含參考資料的 blob 輸入資料來源。

BlobStreamInputDataSource

描述包含資料流程資料的 blob 輸入資料來源。

CompatibilityLevel

控制串流作業的特定執行時間行為。

CsvSerialization

描述如何序列化輸入的資料,或將資料寫入 CSV 格式的輸出時如何序列化。

DiagnosticCondition

適用于資源的條件,或可讓客戶注意的整體作業。

Diagnostics

描述可讓客戶注意的輸入、輸出或工作整體適用的條件。

DocumentDbOutputDataSource

描述 DocumentDB 輸出資料來源。

Encoding

在輸入時指定傳入資料的編碼方式,並在輸出時指定傳出資料的編碼方式。

Error

常見的錯誤標記法。

EventHubOutputDataSource

描述事件中樞輸出資料來源。

EventHubStreamInputDataSource

描述包含資料流程資料的事件中樞輸入資料來源。

EventSerializationType

指出輸入或輸出所使用的序列化類型。 在 PUT (為 createorreplace) 要求時需要。

EventsOutOfOrderPolicy

表示要套用至輸入事件資料流程中依順序抵達之事件的原則。

Function

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

FunctionInput

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

FunctionOutput

描述函數的輸出。

Input

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

IoTHubStreamInputDataSource

描述包含資料流程資料的 IoT 中樞輸入資料來源。

JavaScriptFunctionBinding

JavaScript 函數的系結。

JsonOutputSerializationFormat

指定將寫入輸出的 JSON 格式。 目前支援的值為 ' lineSeparated ',指出輸出將會以新行分隔每個 JSON 物件的格式,而「陣列」表示輸出將會格式化為 JSON 物件的陣列。

JsonSerialization

描述如何序列化輸入的資料,或將資料寫入 JSON 格式的輸出時如何序列化。

Output

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

OutputErrorPolicy

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

OutputStartMode

值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,指出輸出事件資料流程的起始點是否應在工作啟動時啟動、從透過 outputStartTime 屬性指定的自訂使用者時間戳記開始,或從最後一個事件輸出時間開始。

PowerBIOutputDataSource

描述 Power BI 輸出資料來源。

ReferenceInputProperties

與包含參考資料的輸入相關聯的屬性。

ScalarFunctionProperties

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

ServiceBusQueueOutputDataSource

描述服務匯流排佇列輸出資料來源。

ServiceBusTopicOutputDataSource

描述服務匯流排主題輸出資料來源。

Sku

與 SKU 相關聯的屬性。

SkuName

SKU 的名稱。 在 PUT (為 createorreplace) 要求時需要。

StorageAccount

與 Azure 儲存體帳戶相關聯的屬性

StreamingJob

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

StreamingJobListResult

包含串流作業清單的物件。

StreamInputProperties

與包含資料流程資料之輸入相關聯的屬性。

Transformation

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

AvroSerialization

描述如何序列化輸入中的資料,或將資料寫入 Avro 格式的輸出時如何序列化。

Name Type Description
type string:
  • Avro

指出輸入或輸出所使用的序列化類型。 在 PUT (為 createorreplace) 要求時需要。

AzureDataLakeStoreOutputDataSource

描述 Azure Data Lake 儲存輸出資料來源。

Name Type Description
properties.accountName
  • string

Azure Data Lake 存放區帳戶的名稱。 在 PUT (為 createorreplace) 要求時需要。

properties.dateFormat
  • string

日期格式。 在 filePathPrefix 中出現 {date} 時,會改為使用這個屬性的值做為日期格式。

properties.filePathPrefix
  • string

應寫入輸出之檔案的位置。 在 PUT (為 createorreplace) 要求時需要。

properties.refreshToken
  • string

可以用來取得有效存取權杖的重新整理權杖,然後可用來向資料來源進行驗證。 目前只能透過 Azure 入口網站來使用有效的重新整理權杖。 建議您在建立資料來源時將虛設字串值放在這裡,然後前往 Azure 入口網站來驗證資料來源,這會使用有效的重新整理權杖來更新此屬性。 在 PUT (為 createorreplace) 要求時需要。

properties.tenantId
  • string

用來取得重新整理權杖之使用者的租使用者識別碼。 在 PUT (為 createorreplace) 要求時需要。

properties.timeFormat
  • string

時間格式。 在 filePathPrefix 中出現 {time} 時,就會改為使用這個屬性的值做為時間格式。

properties.tokenUserDisplayName
  • string

用來取得重新整理權杖之使用者的使用者顯示名稱。 您可以使用這個屬性來協助記住哪些使用者是用來取得重新整理權杖。

properties.tokenUserPrincipalName
  • string

使用者主體名稱 (用來取得重新整理權杖之使用者的 UPN) 。 您可以使用這個屬性來協助記住哪些使用者是用來取得重新整理權杖。

type string:
  • Microsoft.DataLake/Accounts

指出將寫入資料來源輸出的類型。 在 PUT (為 createorreplace) 要求時需要。

AzureMachineLearningWebServiceFunctionBinding

Azure Machine Learning web 服務的系結。

Name Type Description
properties.apiKey
  • string

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

properties.batchSize
  • integer

介於1到10000之間的數位,描述每個 Azure ML RR execute 要求的最大資料列數。 預設值為 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

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

properties.outputs

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

type string:
  • Microsoft.MachineLearning/WebService

指出函數系結類型。

AzureMachineLearningWebServiceInputColumn

描述 Azure Machine Learning web 服務端點的輸入資料行。

Name Type 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 服務端點的輸入。

Name Type Description
columnNames

Azure Machine Learning web 服務端點的輸入資料行清單。

name
  • string

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

AzureMachineLearningWebServiceOutputColumn

描述 Azure Machine Learning web 服務端點的輸出資料行。

Name Type Description
dataType
  • string

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

name
  • string

輸出資料行的名稱。

AzureSqlDatabaseOutputDataSource

描述 Azure SQL database 輸出資料來源。

Name Type Description
properties.database
  • string

Azure SQL database 的名稱。 在 PUT (為 createorreplace) 要求時需要。

properties.password
  • string

將用來連線到 Azure SQL database 的密碼。 在 PUT (為 createorreplace) 要求時需要。

properties.server
  • string

包含 Azure SQL database 的 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) 要求時需要。

AzureTableOutputDataSource

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

Name Type 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 輸出資料來源。

Name Type Description
properties.container
  • string

相關聯儲存體帳戶內的容器名稱。 此容器包含要從中讀取或寫入的 blob (s) 。 在 PUT (為 createorreplace) 要求時需要。

properties.dateFormat
  • string

日期格式。 在 pathPattern 中出現 {date} 時,會改為使用這個屬性的值做為日期格式。

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.Storage/Blob

指出將寫入資料來源輸出的類型。 在 PUT (為 createorreplace) 要求時需要。

BlobReferenceInputDataSource

描述包含參考資料的 blob 輸入資料來源。

Name Type Description
properties.container
  • string

相關聯儲存體帳戶內的容器名稱。 此容器包含要從中讀取或寫入的 blob (s) 。 在 PUT (為 createorreplace) 要求時需要。

properties.dateFormat
  • string

日期格式。 在 pathPattern 中出現 {date} 時,會改為使用這個屬性的值做為日期格式。

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.Storage/Blob

指出包含參考資料的輸入資料來源類型。 在 PUT (為 createorreplace) 要求時需要。

BlobStreamInputDataSource

描述包含資料流程資料的 blob 輸入資料來源。

Name Type Description
properties.container
  • string

相關聯儲存體帳戶內的容器名稱。 此容器包含要從中讀取或寫入的 blob (s) 。 在 PUT (為 createorreplace) 要求時需要。

properties.dateFormat
  • string

日期格式。 在 pathPattern 中出現 {date} 時,會改為使用這個屬性的值做為日期格式。

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-256。

properties.storageAccounts

一或多個 Azure 儲存體帳戶的清單。 在 PUT (為 createorreplace) 要求時需要。

properties.timeFormat
  • string

時間格式。 在 pathPattern 中出現 {time} 時,就會改為使用這個屬性的值做為時間格式。

type string:
  • Microsoft.Storage/Blob

指出包含資料流程資料的輸入資料來源類型。 在 PUT (為 createorreplace) 要求時需要。

CompatibilityLevel

控制串流作業的特定執行時間行為。

Name Type Description
1.0
  • string

CsvSerialization

描述如何序列化輸入的資料,或將資料寫入 CSV 格式的輸出時如何序列化。

Name Type Description
properties.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

適用于資源的條件,或可讓客戶注意的整體作業。

Name Type Description
code
  • string

不透明的診斷程式代碼。

message
  • string

人們看得懂的訊息,以詳細說明條件。 在用戶端要求的 Accept-Language 中當地語系化。

since
  • string

條件開始的 UTC 時間戳記。 在這段時間內,客戶應該可以在 ops 記錄中找到對應的事件。

Diagnostics

描述可讓客戶注意的輸入、輸出或工作整體適用的條件。

Name Type Description
conditions

適用于資源的零或多個條件的集合,或可讓客戶注意的整體作業。

DocumentDbOutputDataSource

描述 DocumentDB 輸出資料來源。

Name Type Description
properties.accountId
  • string

DocumentDB 帳戶名稱或識別碼。 在 PUT (為 createorreplace) 要求時需要。

properties.accountKey
  • string

DocumentDB 帳戶的帳戶金鑰。 在 PUT (為 createorreplace) 要求時需要。

properties.collectionNamePattern
  • string

要使用之集合的集合名稱模式。 您可以使用選用的 {partition} 語彙基元來建構集合名稱的格式,其中的資料分割會從 0 開始。 如需詳細資訊,請參閱的 DocumentDB 一節 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output 。 在 PUT (為 createorreplace) 要求時需要。

properties.database
  • string

DocumentDB 資料庫的名稱。 在 PUT (為 createorreplace) 要求時需要。

properties.documentId
  • string

輸出事件中的欄位名稱會用來指定主索引鍵,其為插入或更新作業的依據。

properties.partitionKey
  • string

輸出事件中的欄位名稱會用來為跨集合的資料分割輸出指定索引鍵。 如果 ' collectionNamePattern ' 包含 {partition} token,則必須指定這個屬性。

type string:
  • Microsoft.Storage/DocumentDB

指出將寫入資料來源輸出的類型。 在 PUT (為 createorreplace) 要求時需要。

Encoding

在輸入時指定傳入資料的編碼方式,並在輸出時指定傳出資料的編碼方式。

Name Type Description
UTF8
  • string

Error

常見的錯誤標記法。

Name Type Description
error

錯誤定義屬性。

EventHubOutputDataSource

描述事件中樞輸出資料來源。

Name Type Description
properties.eventHubName
  • string

事件中樞的名稱。 在 PUT (為 createorreplace) 要求時需要。

properties.partitionKey
  • string

用來判斷要傳送事件資料之資料分割的索引鍵/資料行。

serviceBusNamespace
  • string

與所需事件中樞、服務匯流排佇列、服務匯流排主題等相關聯的命名空間。在 PUT (為 createorreplace) 要求時需要。

sharedAccessPolicyKey
  • string

指定之共用存取原則的共用存取原則金鑰。 在 PUT (為 createorreplace) 要求時需要。

sharedAccessPolicyName
  • string

事件中樞、服務匯流排佇列、服務匯流排主題等的共用存取原則名稱。在 PUT (為 createorreplace) 要求時需要。

type string:
  • Microsoft.ServiceBus/EventHub

指出將寫入資料來源輸出的類型。 在 PUT (為 createorreplace) 要求時需要。

EventHubStreamInputDataSource

描述包含資料流程資料的事件中樞輸入資料來源。

Name Type Description
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) 要求時需要。

EventSerializationType

指出輸入或輸出所使用的序列化類型。 在 PUT (為 createorreplace) 要求時需要。

Name Type Description
Avro
  • string
Csv
  • string
Json
  • string

EventsOutOfOrderPolicy

表示要套用至輸入事件資料流程中依順序抵達之事件的原則。

Name Type Description
Adjust
  • string
Drop
  • string

Function

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

Name Type Description
id
  • string

資源識別碼

name
  • string

資源名稱

properties FunctionProperties:

與函式相關聯的屬性。

type
  • string

資源類型

FunctionInput

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

Name Type Description
dataType
  • string

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

isConfigurationParameter
  • boolean

指出參數是否為設定參數的旗標。 如果此輸入參數應為常數,則為 True。 預設值為 false。

FunctionOutput

描述函數的輸出。

Name Type Description
dataType
  • string

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

Input

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

Name Type Description
id
  • string

資源識別碼

name
  • string

資源名稱

properties InputProperties:

與輸入相關聯的屬性。 在 PUT (為 createorreplace) 要求時需要。

type
  • string

資源類型

IoTHubStreamInputDataSource

描述包含資料流程資料的 IoT 中樞輸入資料來源。

Name Type Description
properties.consumerGroupName
  • string

應該用來從 IoT 中樞讀取事件的 IoT 中樞取用者組名。 如果未指定,則輸入會使用 Iot 中樞的預設取用者群組。

properties.endpoint
  • string

要連接 (ie 的 IoT 中樞端點。訊息/事件、訊息/operationsMonitoringEvents 等 ) 。

properties.iotHubNamespace
  • string

IoT 中樞的名稱或 URI。 在 PUT (為 createorreplace) 要求時需要。

properties.sharedAccessPolicyKey
  • string

指定之共用存取原則的共用存取原則金鑰。 在 PUT (為 createorreplace) 要求時需要。

properties.sharedAccessPolicyName
  • string

IoT 中樞的共用存取原則名稱。 此原則至少必須包含 Service connect 許可權。 在 PUT (為 createorreplace) 要求時需要。

type string:
  • Microsoft.Devices/IotHubs

指出包含資料流程資料的輸入資料來源類型。 在 PUT (為 createorreplace) 要求時需要。

JavaScriptFunctionBinding

JavaScript 函數的系結。

Name Type Description
properties.script
  • string

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

type string:
  • Microsoft.StreamAnalytics/JavascriptUdf

指出函數系結類型。

JsonOutputSerializationFormat

指定將寫入輸出的 JSON 格式。 目前支援的值為 ' lineSeparated ',指出輸出將會以新行分隔每個 JSON 物件的格式,而「陣列」表示輸出將會格式化為 JSON 物件的陣列。

Name Type Description
Array
  • string
LineSeparated
  • string

JsonSerialization

描述如何序列化輸入的資料,或將資料寫入 JSON 格式的輸出時如何序列化。

Name Type Description
properties.encoding

在輸入時指定傳入資料的編碼方式,並在輸出時指定傳出資料的編碼方式。 在 PUT (為 createorreplace) 要求時需要。

properties.format

這個屬性只適用于輸出的 JSON 序列化。 它不適用於輸入。 這個屬性會指定要寫入輸出的 JSON 格式。 目前支援的值為 ' lineSeparated ',指出輸出將會以新行分隔每個 JSON 物件的格式,而「陣列」表示輸出將會格式化為 JSON 物件的陣列。 如果保留 null,預設值為 ' lineSeparated '。

type string:
  • Json

指出輸入或輸出所使用的序列化類型。 在 PUT (為 createorreplace) 要求時需要。

Output

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

Name Type Description
id
  • string

資源識別碼

name
  • string

資源名稱

properties.datasource OutputDataSource:

描述輸出將寫入的資料來源。 在 PUT (為 createorreplace) 要求時需要。

properties.diagnostics

描述可讓客戶注意的輸入、輸出或工作整體適用的條件。

properties.etag
  • string

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

properties.serialization Serialization:

描述如何序列化輸入中的資料,或將資料寫入輸出時如何序列化。 在 PUT (為 createorreplace) 要求時需要。

type
  • string

資源類型

OutputErrorPolicy

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

Name Type Description
Drop
  • string
Stop
  • string

OutputStartMode

值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,指出輸出事件資料流程的起始點是否應在工作啟動時啟動、從透過 outputStartTime 屬性指定的自訂使用者時間戳記開始,或從最後一個事件輸出時間開始。

Name Type Description
CustomTime
  • string
JobStartTime
  • string
LastOutputEventTime
  • string

PowerBIOutputDataSource

描述 Power BI 輸出資料來源。

Name Type Description
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

與包含參考資料的輸入相關聯的屬性。

Name Type Description
datasource ReferenceInputDataSource:

描述包含參考資料的輸入資料來源。 在 PUT (為 createorreplace) 要求時需要。

diagnostics

描述可讓客戶注意的輸入、輸出或工作整體適用的條件。

etag
  • string

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

serialization Serialization:

描述如何序列化輸入中的資料,或將資料寫入輸出時如何序列化。 在 PUT (為 createorreplace) 要求時需要。

type string:
  • Reference

指出輸入是否為參考資料或資料流程資料的來源。 在 PUT (為 createorreplace) 要求時需要。

ScalarFunctionProperties

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

Name Type Description
etag
  • string

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

properties.binding FunctionBinding:

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

properties.inputs

描述函數參數的輸入清單。

properties.output

函數的輸出。

type string:
  • Scalar

表示函數的類型。

ServiceBusQueueOutputDataSource

描述服務匯流排佇列輸出資料來源。

Name Type Description
properties.propertyColumns
  • string[]

要附加至服務匯流排訊息作為自訂屬性之輸出資料行名稱的字串陣列。

properties.queueName
  • string

服務匯流排佇列的名稱。 在 PUT (為 createorreplace) 要求時需要。

properties.serviceBusNamespace
  • string

與所需事件中樞、服務匯流排佇列、服務匯流排主題等相關聯的命名空間。在 PUT (為 createorreplace) 要求時需要。

properties.sharedAccessPolicyKey
  • string

指定之共用存取原則的共用存取原則金鑰。 在 PUT (為 createorreplace) 要求時需要。

properties.sharedAccessPolicyName
  • string

事件中樞、服務匯流排佇列、服務匯流排主題等的共用存取原則名稱。在 PUT (為 createorreplace) 要求時需要。

type string:
  • Microsoft.ServiceBus/Queue

指出將寫入資料來源輸出的類型。 在 PUT (為 createorreplace) 要求時需要。

ServiceBusTopicOutputDataSource

描述服務匯流排主題輸出資料來源。

Name Type Description
properties.propertyColumns
  • string[]

要附加至服務匯流排訊息作為自訂屬性之輸出資料行名稱的字串陣列。

properties.serviceBusNamespace
  • string

與所需事件中樞、服務匯流排佇列、服務匯流排主題等相關聯的命名空間。在 PUT (為 createorreplace) 要求時需要。

properties.sharedAccessPolicyKey
  • string

指定之共用存取原則的共用存取原則金鑰。 在 PUT (為 createorreplace) 要求時需要。

properties.sharedAccessPolicyName
  • string

事件中樞、服務匯流排佇列、服務匯流排主題等的共用存取原則名稱。在 PUT (為 createorreplace) 要求時需要。

properties.topicName
  • string

服務匯流排主題的名稱。 在 PUT (為 createorreplace) 要求時需要。

type string:
  • Microsoft.ServiceBus/Topic

指出將寫入資料來源輸出的類型。 在 PUT (為 createorreplace) 要求時需要。

Sku

與 SKU 相關聯的屬性。

Name Type Description
name

SKU 的名稱。 在 PUT (為 createorreplace) 要求時需要。

SkuName

SKU 的名稱。 在 PUT (為 createorreplace) 要求時需要。

Name Type Description
Standard
  • string

StorageAccount

與 Azure 儲存體帳戶相關聯的屬性

Name Type Description
accountKey
  • string

Azure 儲存體帳戶的帳戶金鑰。 在 PUT (為 createorreplace) 要求時需要。

accountName
  • string

Azure 儲存體帳戶的名稱。 在 PUT (為 createorreplace) 要求時需要。

StreamingJob

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

Name Type Description
id
  • string

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

location
  • string

資源所在的地理位置

name
  • string

資源的名稱

properties.compatibilityLevel

控制串流作業的特定執行時間行為。

properties.createdDate
  • string

值是 ISO-8601 格式的 UTC 時間戳記,指出串流作業的建立時間。

properties.dataLocale
  • string

串流分析作業的資料地區設定。 值應該是集合中支援的 .NET 文化特性的名稱 https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx 。 如果未指定,則預設為 ' en-us '。

properties.etag
  • string

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

properties.eventsLateArrivalMaxDelayInSeconds
  • integer

可以包含延遲延遲的最大可容忍延遲(以秒為單位)。 支援的範圍為-1 至 1814399 (20.23:59:59天) ,而-1 用來指定無限期等候。 如果屬性不存在,則會將其解釋為值-1。

properties.eventsOutOfOrderMaxDelayInSeconds
  • integer

可依序調整順序外事件的最大可容忍延遲(以秒為單位)。

properties.eventsOutOfOrderPolicy

表示要套用至輸入事件資料流程中依順序抵達之事件的原則。

properties.functions

串流作業的一或多個函式清單。 在 PUT 要求中指定這個屬性時,需要每個函數的 name 屬性。 無法透過修補作業來修改此屬性。 您必須使用適用于個別轉換的 PATCH API。

properties.inputs

串流作業的一或多個輸入清單。 在 PUT 要求中指定這個屬性時,需要每個輸入的 name 屬性。 無法透過修補作業來修改此屬性。 您必須使用適用于個別輸入的 PATCH API。

properties.jobId
  • string

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

properties.jobState
  • string

描述串流作業的狀態。

properties.lastOutputEventTime
  • string

值是一種 ISO-8601 格式的時間戳記,指出串流作業的最後輸出事件時間,或指出尚未產生輸出的 null。 如果有多個輸出或多個資料流程,這會顯示該集合中的最新值。

properties.outputErrorPolicy

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

properties.outputStartMode

只有當您想要在建立作業時立即啟動作業時,才應該使用此屬性。 值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,指出輸出事件資料流程的起始點是否應在工作啟動時啟動、從透過 outputStartTime 屬性指定的自訂使用者時間戳記開始,或從最後一個事件輸出時間開始。

properties.outputStartTime
  • string

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

properties.outputs

串流作業的一或多個輸出清單。 在 PUT 要求中指定這個屬性時,需要每個輸出的 name 屬性。 無法透過修補作業來修改此屬性。 您必須使用適用于個別輸出的 PATCH API。

properties.provisioningState
  • string

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

properties.sku

描述串流作業的 SKU。 在 PUT (為 createorreplace) 要求時需要。

properties.transformation

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

tags
  • object

資源標籤。

type
  • string

資源類型。 例如,Microsoft. Compute/virtualMachines 或 Microsoft. Storage/storageAccounts。

StreamingJobListResult

包含串流作業清單的物件。

Name Type Description
nextLink
  • string

連結 (url) 至下一個結果頁面。

value

串流作業的清單。 填入「清單」作業。

StreamInputProperties

與包含資料流程資料之輸入相關聯的屬性。

Name Type Description
datasource StreamInputDataSource:

描述包含資料流程資料的輸入資料來源。 在 PUT (為 createorreplace) 要求時需要。

diagnostics

描述可讓客戶注意的輸入、輸出或工作整體適用的條件。

etag
  • string

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

serialization Serialization:

描述如何序列化輸入中的資料,或將資料寫入輸出時如何序列化。 在 PUT (為 createorreplace) 要求時需要。

type string:
  • Stream

指出輸入是否為參考資料或資料流程資料的來源。 在 PUT (為 createorreplace) 要求時需要。

Transformation

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

Name Type Description
id
  • string

資源識別碼

name
  • string

資源名稱

properties.etag
  • string

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

properties.query
  • string

指定將在串流作業中執行的查詢。 您可以在這裡深入瞭解串流分析查詢語言 (SAQL) : https://msdn.microsoft.com/library/azure/dn834998 。 在 PUT (為 createorreplace) 要求時需要。

properties.streamingUnits
  • integer

指定串流作業所使用的串流單位數目。

type
  • string

資源類型