Time Series Types - Execute Batch

參考

Service:: Time Series Insights

API Version:: 2020-07-31

在多個時間序列類型上執行批次取得、建立、更新、刪除作業。

POST https://{environmentFqdn}/timeseries/types/$batch?api-version=2020-07-31

URI 參數

名稱	位於	必要	類型	Description
environmentFqdn	path	True	string	每個環境 FQDN，例如 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com。您可以從取得環境 API、Azure 入口網站或 Azure Resource Manager 的回應取得此功能變數名稱。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。目前支援的版本為「2020-07-31」。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string	選擇性用戶端要求識別碼。服務會記錄此值。允許服務追蹤服務之間的作業，並允許客戶連絡有關特定要求的支持人員。
x-ms-client-session-id		string	選擇性用戶端會話識別碼。服務會記錄此值。允許服務追蹤跨服務的相關作業群組，並允許客戶連絡支持人員，以取得特定要求群組的相關信息。

要求本文

名稱	類型	Description
delete	TypesRequestBatchGetOrDelete	要刪除的時間序列類型定義。
get	TypesRequestBatchGetOrDelete	要傳回的時間序列類型定義。
put	TimeSeriesType[]	要更新或建立哪些時間序列類型的定義。

回應

名稱	類型	Description
200 OK	TypesBatchResponse	成功的作業。 Headers x-ms-request-id: string
Other Status Codes	TsiError	非預期的錯誤。 Headers x-ms-request-id: string

名稱

類型

Description

200 OK

TypesBatchResponse

成功的作業。

Headers

x-ms-request-id: string

Other Status Codes

TsiError

非預期的錯誤。

Headers

x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

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

範例

TypesBatchDeleteByIds

TypesBatchDeleteByNames

TypesBatchGetByIds

TypesBatchGetByNames

TypesBatchPut

TypesBatchDeleteByIds

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "delete": {
    "typeIds": [
      "9250f816-faed-44c4-88e6-630e5eefa38b"
    ]
  }
}

Sample Response

Status code:: 200

{
  "delete": [
    null
  ]
}

TypesBatchDeleteByNames

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "delete": {
    "names": [
      "TemperatureSensor"
    ]
  }
}

Sample Response

Status code:: 200

{
  "delete": [
    null
  ]
}

TypesBatchGetByIds

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "get": {
    "typeIds": [
      "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8"
    ],
    "names": null
  }
}

Sample Response

Status code:: 200

{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchGetByNames

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "get": {
    "names": [
      "DefaultType",
      "TemperatureSensor"
    ]
  }
}

Sample Response

Status code:: 200

{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchPut

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/types/$batch?api-version=2020-07-31

{
  "put": [
    {
      "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "name": "DefaultType",
      "description": "My Default type",
      "variables": {
        "EventCount": {
          "kind": "aggregate",
          "filter": null,
          "aggregation": {
            "tsx": "count()"
          }
        }
      }
    },
    {
      "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
      "name": "OutdoorTemperatureSensor",
      "description": "This is an outdoor temperature sensor.",
      "variables": {
        "AverageTemperature": {
          "kind": "numeric",
          "value": {
            "tsx": "$event.Temperature.Double"
          },
          "filter": {
            "tsx": "$event.Mode.String = 'outdoor'"
          },
          "aggregation": {
            "tsx": "avg($value)"
          }
        }
      }
    }
  ]
}

Sample Response

Status code:: 200

{
  "put": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "My Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "OutdoorTemperatureSensor",
        "description": "This is an outdoor temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": {
              "tsx": "$event.Mode.String = 'outdoor'"
            },
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

定義

名稱	Description
AggregateVariable	匯總變數代表任何匯總計算。匯總變數不支援插補。
Boundary	要用於插補的搜尋範圍左邊和右邊的時間範圍。在接近輸入搜尋範圍的開始或結尾處遺漏數據點的情況下，這會很有説明。可以是 null。
CategoricalVariable	類別變數代表必須根據一組有限定義值出現次數或持續時間進行分析的訊號。
Interpolation	要對原始數據點執行的插補作業。目前只允許取樣插補時間序列。允許的聚合函數 - 例如：左方 ($value) 。如果不需要套用插補點，則可以為 null。
InterpolationKind	插補技術的類型：「Linear」或「Step」。。
NumericVariable	數值變數代表可使用插補重新建構的單一連續數值訊號。
TimeSeriesAggregateCategory	類別變數中使用的類別。類別是由 'label' 和指派此標籤的 'values' 所定義。
TimeSeriesDefaultCategory	表示預設類別。
TimeSeriesType	時間序列類型會定義變數或公式，以針對與時間序列實例相關聯的事件執行計算。每個時間序列實例都與一個類型相關聯。一個類型可以有一或多個變數。例如，時間序列實例的類型可能是 Temperature Sensor，其中包含變數 avg temperature、min temperature 和 max temperature。
TimeSeriesTypeOrError	特定時間序列類型的批次作業結果。作業成功時會設定類型物件，並在作業失敗時設定錯誤物件。
TsiError	API 錯誤的相關信息。
TsiErrorBody	具有錯誤碼和訊息的特定 API 錯誤。
TsiErrorDetails	其他錯誤資訊。
Tsx	時間序列表達式 (TSX) 寫入為單一字串。範例：「$event。Status.String='Good'，“avg ($event。溫度) 」。請參閱有關如何撰寫時間序列表達式的檔。
TypesBatchRequest	要求在時間序列類型的批次上執行單一作業。必須設定「get」、“put” 或「delete」的其中一個。
TypesBatchResponse	一批時間序列類型的單一作業回應。只會設定其中一個「get」、“put” 或「delete」。
TypesRequestBatchGetOrDelete	依標識碼或類型名稱取得或刪除時間序列類型的要求。必須設定「typeIds」或「names」的其中一個。

AggregateVariable

匯總變數代表任何匯總計算。匯總變數不支援插補。

名稱	類型	Description
aggregation	Tsx	當種類為「aggregate」時，匯總時間序列表達式是用來表示需要使用「$event」等事件屬性直接執行的匯總。溫度」。例如，計算溫度變更範圍的匯總可以寫入為：「max ($event。溫度) 分鐘 ($event。溫度) 」。
filter	Tsx	篩選限制要考慮計算的事件數目的事件。範例：「$event。Status.String='Good'”。選擇性。
kind	string: aggregate	允許的“kind” 值為 - “numeric” 或 “aggregate”。雖然「numeric」可讓您指定重新建構訊號的值和匯總它們的表達式，但「匯總」種類可讓您直接匯總事件屬性，而不需要指定值。

Boundary

要用於插補的搜尋範圍左邊和右邊的時間範圍。在接近輸入搜尋範圍的開始或結尾處遺漏數據點的情況下，這會很有説明。可以是 null。

名稱	類型	Description
span	string

CategoricalVariable

類別變數代表必須根據一組有限定義值出現次數或持續時間進行分析的訊號。

名稱	類型	Description
categories	TimeSeriesAggregateCategory[]	類別變數中使用的類別。類別是由 'label' 和指派此標籤的 'values' 所定義。
defaultCategory	TimeSeriesDefaultCategory	表示預設類別。
filter	Tsx	篩選限制要考慮計算的事件數目的事件。範例：「$event。Status.String='Good'”。選擇性。
interpolation	Interpolation	類別變數僅支援『step』插補。
kind	string: categorical	允許的“kind” 值為 - “numeric” 或 “aggregate”。雖然「numeric」可讓您指定重新建構訊號的值和匯總它們的表達式，但「匯總」種類可讓您直接匯總事件屬性，而不需要指定值。
value	Tsx	值時間序列表達式用來表示即將分類的訊號值。它只能評估為類別變數的『String』或 'Long' 類型。

Interpolation

要對原始數據點執行的插補作業。目前只允許取樣插補時間序列。允許的聚合函數 - 例如：左方 ($value) 。如果不需要套用插補點，則可以為 null。

名稱	類型	Description
boundary	Boundary	要用於插補的搜尋範圍左邊和右邊的時間範圍。在接近輸入搜尋範圍的開始或結尾處遺漏數據點的情況下，這會很有説明。可以是 null。
kind	InterpolationKind	插補技術的類型：「Linear」或「Step」。。

InterpolationKind

插補技術的類型：「Linear」或「Step」。。

名稱	類型	Description
Linear	string
Step	string

NumericVariable

數值變數代表可使用插補重新建構的單一連續數值訊號。

名稱	類型	Description
aggregation	Tsx	當種類為「numeric」時，匯總時間序列表達式會用來表示必須在$value表達式上執行的匯總。這需要指定$value，而且只能在聚合函數內使用$value。例如，計算$value最小值的匯總會寫入為：“min ($value) ”。
filter	Tsx	篩選限制要考慮計算的事件數目的事件。範例：「$event。Status.String='Good'”。選擇性。
interpolation	Interpolation	要對原始數據點執行的插補作業。目前只允許取樣插補時間序列。允許的聚合函數 - 例如：左方 ($value) 。如果不需要套用插補點，則可以為 null。
kind	string: numeric	允許的“kind” 值為 - “numeric” 或 “aggregate”。雖然「numeric」可讓您指定重新建構訊號的值和匯總它們的表達式，但「匯總」種類可讓您直接匯總事件屬性，而不需要指定值。
value	Tsx	值時間序列表達式是用來表示即將匯總或插補的訊號值。例如，事件中的溫度值會以下列方式表示：「$event。Temperature.Double”。

TimeSeriesAggregateCategory

類別變數中使用的類別。類別是由 'label' 和指派此標籤的 'values' 所定義。

名稱	類型	Description
label	string	將用於建構輸出變數名稱的類別名稱。
values	object[]	類別目錄所對應的值清單。可以是唯一的字串清單或long清單。

TimeSeriesDefaultCategory

表示預設類別。

名稱	類型	Description
label	string	默認類別的名稱，將會指派給不符合『categories』中所定義之任何值的值。

TimeSeriesType

時間序列類型會定義變數或公式，以針對與時間序列實例相關聯的事件執行計算。每個時間序列實例都與一個類型相關聯。一個類型可以有一或多個變數。例如，時間序列實例的類型可能是 Temperature Sensor，其中包含變數 avg temperature、min temperature 和 max temperature。

名稱	類型	Description
description	string	類型的描述。可能是 Null。
id	string	不可變區分大小寫的唯一類型標識碼。在建立或更新要求時可以是 null，然後伺服器會產生標識碼。取得和刪除作業時不是 Null。
name	string	型別的使用者指定唯一名稱。可變動，而非 Null。
variables	object	與類型相關聯的不同變數。不是空的，不是 Null。

TimeSeriesTypeOrError

特定時間序列類型的批次作業結果。作業成功時會設定類型物件，並在作業失敗時設定錯誤物件。

名稱	類型	Description
error	TsiErrorBody	錯誤物件 - 在作業失敗時設定。
timeSeriesType	TimeSeriesType	時間序列類型物件 - 在作業成功時設定。

TsiError

API 錯誤的相關信息。

名稱	類型	Description
error	TsiErrorBody	具有錯誤碼和訊息的特定 API 錯誤。

TsiErrorBody

具有錯誤碼和訊息的特定 API 錯誤。

名稱	類型	Description
code	string	與語言無關且人類可讀取的字串，可定義服務特定的錯誤碼。此程式代碼可作為回應中所指定 HTTP 錯誤碼的更特定指標。可用來以程式設計方式處理特定錯誤案例。
details	TsiErrorDetails[]	包含其他錯誤資訊。可能是 Null。
innerError	TsiErrorBody	包含更明確的錯誤，可縮小原因範圍。可能是 Null。
message	string	人類看得懂且與語言無關的錯誤表示法。它是開發人員的協助，不適合暴露給終端使用者。
target	string	例如，特定錯誤 (的目標為錯誤) 中的屬性名稱。可能是 Null。

TsiErrorDetails

其他錯誤資訊。

名稱	類型	Description
code	string	與語言無關且人類可讀取的字串，可定義服務特定的錯誤碼。此程式代碼可作為回應中所指定 HTTP 錯誤碼的更特定指標。可用來以程式設計方式處理特定錯誤案例。
message	string	人類看得懂且與語言無關的錯誤表示法。它是開發人員的協助，不適合暴露給終端使用者。

Tsx

時間序列表達式 (TSX) 寫入為單一字串。範例：「$event。Status.String='Good'，“avg ($event。溫度) 」。請參閱有關如何撰寫時間序列表達式的檔。

名稱	類型	Description
tsx	string	時間序列表達式 (TSX) 寫入為單一字串。範例：「$event。Status.String='Good'，“avg ($event。溫度) 」。請參閱有關如何撰寫時間序列表達式的檔。

TypesBatchRequest

要求在時間序列類型的批次上執行單一作業。必須設定「get」、“put” 或「delete」的其中一個。

名稱	類型	Description
delete	TypesRequestBatchGetOrDelete	要刪除的時間序列類型定義。
get	TypesRequestBatchGetOrDelete	要傳回的時間序列類型定義。
put	TimeSeriesType[]	要更新或建立哪些時間序列類型的定義。

TypesBatchResponse

一批時間序列類型的單一作業回應。只會設定其中一個「get」、“put” 或「delete」。

名稱	類型	Description
delete	TsiErrorBody[]	由位置對應至要求中「delete」陣列的錯誤物件清單 - 作業成功時為 null。
get	TimeSeriesTypeOrError[]	依位置對應至要求中「get」陣列的類型或錯誤物件清單。作業成功時會設定類型物件，並在作業失敗時設定錯誤物件。
put	TimeSeriesTypeOrError[]	依位置對應至要求中「put」陣列的類型或錯誤物件清單。作業成功時會設定類型物件，並在作業失敗時設定錯誤物件。

TypesRequestBatchGetOrDelete

依標識碼或類型名稱取得或刪除時間序列類型的要求。必須設定「typeIds」或「names」的其中一個。

名稱	類型	Description
names	string[]	要傳回或刪除的時間序列類型名稱清單。
typeIds	string[]	要傳回或刪除之時間序列類型的標識碼清單。

共用方式為

Time Series Types - Execute Batch

URI 參數

要求標頭

要求本文

回應

安全性

azure_auth

Scopes

範例

TypesBatchDeleteByIds

Sample Request

Sample Response

TypesBatchDeleteByNames

Sample Request

Sample Response

TypesBatchGetByIds

Sample Request

Sample Response

TypesBatchGetByNames

Sample Request

Sample Response

TypesBatchPut

Sample Request

Sample Response

定義

AggregateVariable

Boundary

CategoricalVariable

Interpolation

InterpolationKind

NumericVariable

TimeSeriesAggregateCategory

TimeSeriesDefaultCategory

TimeSeriesType

TimeSeriesTypeOrError

TsiError

TsiErrorBody

TsiErrorDetails

Tsx

TypesBatchRequest

TypesBatchResponse

TypesRequestBatchGetOrDelete

其他資源