Time Series Types - Execute Batch

  • Başvuru
Service:
Time Series Insights
API Version:
2020-07-31

Birden çok zaman serisi türünde toplu alma, oluşturma, güncelleştirme, silme işlemini yürütür.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
environmentFqdn
 path True

string

Ortam başına FQDN, örneğin 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Bu etki alanı adını Get Environments API, Azure portal veya Azure Resource Manager yanıtından alabilirsiniz.
api-version
 query True

string

İstemci isteğiyle kullanılacak API sürümü. Şu anda desteklenen sürüm :"2020-07-31".

İstek Başlığı

Name Gerekli Tür Description
x-ms-client-request-id

string

İsteğe bağlı istemci isteği kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında işlemi izlemesine ve müşterinin belirli bir istekle ilgili desteğe başvurmasına olanak tanır.
x-ms-client-session-id

string

İsteğe bağlı istemci oturum kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında bir grup ilgili işlemi izlemesine ve müşterinin belirli bir istek grubuyla ilgili desteğe başvurmasına olanak tanır.

İstek Gövdesi

Name Tür Description
delete

TypesRequestBatchGetOrDelete

Silinecek zaman serisi türlerinin tanımı.
get

TypesRequestBatchGetOrDelete

Döndürülecek zaman serisi türlerinin tanımı.
put

TimeSeriesType[]

Güncelleştirilecek veya oluşturulacak zaman serisi türlerinin tanımı.

Yanıtlar

Name Tür Description
200 OK

TypesBatchResponse

İşlem başarılı.

Headers

x-ms-request-id: string
Other Status Codes

TsiError

Beklenmeyen hata.

Headers

x-ms-request-id: string

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

TypesBatchDeleteByIds
TypesBatchDeleteByNames
TypesBatchGetByIds
TypesBatchGetByNames
TypesBatchPut

TypesBatchDeleteByIds

Sample Request

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

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

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

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

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
    }
  ]
}

Tanımlar

Name Description
AggregateVariable

Toplama değişkeni toplama hesaplamalarını temsil eder. Toplama Değişkenleri ilişkilendirmeyi desteklemez.
Boundary

İlişkilendirme için kullanılacak arama aralığının sol ve sağındaki zaman aralığı. Bu, giriş arama aralığının başlangıcına veya sonuna yakın veri noktalarının eksik olduğu senaryolarda yararlıdır. Boş olabilir.
CategoricalVariable

Kategorik değişken, sınırlı tanımlı değer kümesinin oluşum sayısına veya süresine göre analiz edilmesi gereken sinyali temsil eder.
Interpolation

Ham veri noktalarında gerçekleştirilecek ilişkilendirme işlemi. Şu anda yalnızca ilişkilendirilmiş zaman serisi örneklemesine izin verilir. İzin verilen toplama işlevi - örneğin: left($value). İlişkilendirmenin uygulanması gerekmemesi durumunda null olabilir.
InterpolationKind

İlişkilendirme tekniğinin türü: "Doğrusal" veya "Adım".
NumericVariable

Sayısal değişken, ilişkilendirme kullanılarak yeniden oluşturulabilen tek bir sürekli sayısal sinyali temsil eder.
TimeSeriesAggregateCategory

Kategorik değişkenlerde kullanılan kategori. Kategori, bu etikete atanan 'etiket' ve 'değerler' ile tanımlanır.
TimeSeriesDefaultCategory

Varsayılan kategoriyi temsil eder.
TimeSeriesType

Zaman serisi türü, zaman serisi örnekleriyle ilişkili olaylar üzerinde hesaplama yapmak için değişkenleri veya formülleri tanımlar. Seri örneği her zaman tam olarak bir türle ilişkilendirilir. Bir türün bir veya daha fazla değişkeni olabilir. Örneğin, bir zaman serisi örneği ortalama sıcaklık, en düşük sıcaklık ve maksimum sıcaklık değişkenlerinden oluşan Sıcaklık Sensörü türünde olabilir.
TimeSeriesTypeOrError

Belirli bir zaman serisi türündeki toplu işlemin sonucu. İşlem başarılı olduğunda tür nesnesi ayarlanır ve işlem başarısız olduğunda hata nesnesi ayarlanır.
TsiError

API hatası hakkında bilgi.
TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.
TsiErrorDetails

Ek hata bilgileri.
Tsx

Tek bir dize olarak yazılmış zaman serisi ifadesi (TSX). Örnekler: "$event. Status.String='Good'", "avg($event. Sıcaklık)". Zaman serisi ifadeleri yazma belgelerine bakın.
TypesBatchRequest

Zaman serisi türlerinden oluşan bir toplu iş üzerinde tek bir işlem gerçekleştirme isteği. Tam olarak "get", "put" veya "delete" değerlerinden biri ayarlanmalıdır.
TypesBatchResponse

Zaman serisi türlerinden oluşan bir toplu iş üzerinde tek bir işlemin yanıtı. Tam olarak "get", "put" veya "delete" değerlerinden biri ayarlanır.
TypesRequestBatchGetOrDelete

Zaman serisi türlerini kimliklere veya tür adlarına göre alma veya silme isteği. Tam olarak "typeIds" veya "names" biri ayarlanmalıdır.

AggregateVariable

Toplama değişkeni toplama hesaplamalarını temsil eder. Toplama Değişkenleri ilişkilendirmeyi desteklemez.

Name Tür Description
aggregation

Tsx

Tür "toplama" olduğunda toplama zaman serisi ifadesi, "$event gibi olay özellikleri kullanılarak doğrudan gerçekleştirilmesi gereken toplamayı temsil etmek için kullanılır. Sıcaklık". Örneğin, sıcaklık değişiklik aralığını hesaplamak için toplama şu şekilde yazılabilir: "max($event. Sıcaklık)dk($event. Sıcaklık)".
filter

Tsx

Hesaplama için dikkate alınmakta olan olay sayısını kısıtlayan olayları filtreleyin. Örnek: "$event. Status.String='Good'". İsteğe bağlı.
kind string:

aggregate

İzin verilen "tür" değerleri şunlardır: "sayısal" veya "toplama". "sayısal" yeniden yapılandırılmış sinyalin değerini ve bunları toplamak için ifadeyi belirtmenize olanak sağlarken, "toplama" türü değer belirtmeden olay özellikleri üzerinde doğrudan toplamanızı sağlar.

Boundary

İlişkilendirme için kullanılacak arama aralığının sol ve sağındaki zaman aralığı. Bu, giriş arama aralığının başlangıcına veya sonuna yakın veri noktalarının eksik olduğu senaryolarda yararlıdır. Boş olabilir.

Name Tür Description
span

string

CategoricalVariable

Kategorik değişken, sınırlı tanımlı değer kümesinin oluşum sayısına veya süresine göre analiz edilmesi gereken sinyali temsil eder.

Name Tür Description
categories

TimeSeriesAggregateCategory[]

Kategorik değişkenlerde kullanılan kategori. Kategori, bu etikete atanan 'etiket' ve 'değerler' ile tanımlanır.
defaultCategory

TimeSeriesDefaultCategory

Varsayılan kategoriyi temsil eder.
filter

Tsx

Hesaplama için dikkate alınmakta olan olay sayısını kısıtlayan olayları filtreleyin. Örnek: "$event. Status.String='Good'". İsteğe bağlı.
interpolation

Interpolation

Kategorik değişken yalnızca 'step' ilişkilendirmesini destekler.
kind string:

categorical

İzin verilen "tür" değerleri şunlardır: "sayısal" veya "toplama". "sayısal" yeniden yapılandırılmış sinyalin değerini ve bunları toplamak için ifadeyi belirtmenize olanak sağlarken, "toplama" türü değer belirtmeden olay özellikleri üzerinde doğrudan toplamanızı sağlar.
value

Tsx

Değer zaman serisi ifadesi, kategorilere ayırılacak sinyalin değerini göstermek için kullanılır. Kategorik değişkenler için yalnızca 'String' veya 'Long' türünü değerlendirebilir.

Interpolation

Ham veri noktalarında gerçekleştirilecek ilişkilendirme işlemi. Şu anda yalnızca ilişkilendirilmiş zaman serisi örneklemesine izin verilir. İzin verilen toplama işlevi - örneğin: left($value). İlişkilendirmenin uygulanması gerekmemesi durumunda null olabilir.

Name Tür Description
boundary

Boundary

İlişkilendirme için kullanılacak arama aralığının sol ve sağındaki zaman aralığı. Bu, giriş arama aralığının başlangıcına veya sonuna yakın veri noktalarının eksik olduğu senaryolarda yararlıdır. Boş olabilir.
kind

InterpolationKind

İlişkilendirme tekniğinin türü: "Doğrusal" veya "Adım".

InterpolationKind

İlişkilendirme tekniğinin türü: "Doğrusal" veya "Adım".

Name Tür Description
Linear

string

Step

string

NumericVariable

Sayısal değişken, ilişkilendirme kullanılarak yeniden oluşturulabilen tek bir sürekli sayısal sinyali temsil eder.

Name Tür Description
aggregation

Tsx

Tür "sayısal" olduğunda toplama zaman serisi ifadesi, $value ifadesinde gerçekleştirilmesi gereken toplamayı temsil etmek için kullanılır. Bunun için $value belirtilmesi gerekir ve yalnızca toplama işlevlerinin içindeki $value kullanılabilir. Örneğin, $value minimumunu hesaplamak için toplama şu şekilde yazılır: "min($value)".
filter

Tsx

Hesaplama için dikkate alınmakta olan olay sayısını kısıtlayan olayları filtreleyin. Örnek: "$event. Status.String='Good'". İsteğe bağlı.
interpolation

Interpolation

Ham veri noktalarında gerçekleştirilecek ilişkilendirme işlemi. Şu anda yalnızca ilişkilendirilmiş zaman serisi örneklemesine izin verilir. İzin verilen toplama işlevi - örneğin: left($value). İlişkilendirmenin uygulanması gerekmemesi durumunda null olabilir.
kind string:

numeric

İzin verilen "tür" değerleri şunlardır: "sayısal" veya "toplama". "sayısal" yeniden yapılandırılmış sinyalin değerini ve bunları toplamak için ifadeyi belirtmenize olanak sağlarken, "toplama" türü değer belirtmeden olay özellikleri üzerinde doğrudan toplamanızı sağlar.
value

Tsx

Değer zaman serisi ifadesi, toplanacak veya ilişkilendirilmiş sinyalin değerini temsil etmek için kullanılır. Örneğin, olaydaki sıcaklık değerleri şu şekilde gösterilir: "$event. Sıcaklık.Çift".

TimeSeriesAggregateCategory

Kategorik değişkenlerde kullanılan kategori. Kategori, bu etikete atanan 'etiket' ve 'değerler' ile tanımlanır.

Name Tür Description
label

string

Çıkış değişkeni adlarını oluştururken kullanılacak kategorinin adı.
values

object[]

Bir kategorinin eşlendiğini değerlerin listesi. Benzersiz bir dize listesi veya uzun listesi olabilir.

TimeSeriesDefaultCategory

Varsayılan kategoriyi temsil eder.

Name Tür Description
label

string

'Kategoriler'de tanımlanan değerlerle eşleşmeyen değerlere atanacak varsayılan kategorinin adı.

TimeSeriesType

Zaman serisi türü, zaman serisi örnekleriyle ilişkili olaylar üzerinde hesaplama yapmak için değişkenleri veya formülleri tanımlar. Seri örneği her zaman tam olarak bir türle ilişkilendirilir. Bir türün bir veya daha fazla değişkeni olabilir. Örneğin, bir zaman serisi örneği ortalama sıcaklık, en düşük sıcaklık ve maksimum sıcaklık değişkenlerinden oluşan Sıcaklık Sensörü türünde olabilir.

Name Tür Description
description

string

Türün açıklaması. Null olabilir.
id

string

Sabit büyük/küçük harfe duyarlı benzersiz tür tanımlayıcısı. Oluşturma veya güncelleştirme isteklerinde null olabilir ve ardından sunucu kimliği oluşturur. Alma ve silme işlemlerinde null değil.
name

string

Tür için kullanıcı tarafından verilen benzersiz ad. Değiştirilebilir, null değil.
variables

object

Türle ilişkili farklı değişkenler. Boş değil, null değil.

TimeSeriesTypeOrError

Belirli bir zaman serisi türündeki toplu işlemin sonucu. İşlem başarılı olduğunda tür nesnesi ayarlanır ve işlem başarısız olduğunda hata nesnesi ayarlanır.

Name Tür Description
error

TsiErrorBody

Hata nesnesi - işlem başarısız olduğunda ayarlanır.
timeSeriesType

TimeSeriesType

Zaman serisi türü nesnesi - işlem başarılı olduğunda ayarlanır.

TsiError

API hatası hakkında bilgi.

Name Tür Description
error

TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.

TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.

Name Tür Description
code

string

Hizmete özgü hata kodunu tanımlayan dilden bağımsız, okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha özel bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
details

TsiErrorDetails[]

Ek hata bilgileri içerir. Null olabilir.
innerError

TsiErrorBody

Nedeni daraltan daha belirli bir hata içerir. Null olabilir.
message

string

Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardım amaçlıdır ve son kullanıcılara açıklanma için uygun değildir.
target

string

Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı). Null olabilir.

TsiErrorDetails

Ek hata bilgileri.

Name Tür Description
code

string

Hizmete özgü hata kodunu tanımlayan dilden bağımsız, okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha özel bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
message

string

Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardım amaçlıdır ve son kullanıcılara açıklanma için uygun değildir.

Tsx

Tek bir dize olarak yazılmış zaman serisi ifadesi (TSX). Örnekler: "$event. Status.String='Good'", "avg($event. Sıcaklık)". Zaman serisi ifadeleri yazma belgelerine bakın.

Name Tür Description
tsx

string

Tek bir dize olarak yazılmış zaman serisi ifadesi (TSX). Örnekler: "$event. Status.String='Good'", "avg($event. Sıcaklık)". Zaman serisi ifadeleri yazma belgelerine bakın.

TypesBatchRequest

Zaman serisi türlerinden oluşan bir toplu iş üzerinde tek bir işlem gerçekleştirme isteği. Tam olarak "get", "put" veya "delete" değerlerinden biri ayarlanmalıdır.

Name Tür Description
delete

TypesRequestBatchGetOrDelete

Silinecek zaman serisi türlerinin tanımı.
get

TypesRequestBatchGetOrDelete

Döndürülecek zaman serisi türlerinin tanımı.
put

TimeSeriesType[]

Güncelleştirilecek veya oluşturulacak zaman serisi türlerinin tanımı.

TypesBatchResponse

Zaman serisi türlerinden oluşan bir toplu iş üzerinde tek bir işlemin yanıtı. Tam olarak "get", "put" veya "delete" değerlerinden biri ayarlanır.

Name Tür Description
delete

TsiErrorBody[]

İşlem başarılı olduğunda istekteki "delete" dizisine karşılık gelen hata nesnelerinin listesi - null.
get

TimeSeriesTypeOrError[]

İstekteki "get" dizisinin konumuna göre karşılık gelen türlerin veya hata nesnelerinin listesi. İşlem başarılı olduğunda tür nesnesi ayarlanır ve işlem başarısız olduğunda hata nesnesi ayarlanır.
put

TimeSeriesTypeOrError[]

İstekteki "put" dizisinin konumuna göre karşılık gelen türlerin veya hata nesnelerinin listesi. İşlem başarılı olduğunda tür nesnesi ayarlanır ve işlem başarısız olduğunda hata nesnesi ayarlanır.

TypesRequestBatchGetOrDelete

Zaman serisi türlerini kimliklere veya tür adlarına göre alma veya silme isteği. Tam olarak "typeIds" veya "names" biri ayarlanmalıdır.

Name Tür Description
names

string[]

Döndürülecek veya silinecek zaman serisi türlerinin adları listesi.
typeIds

string[]

Döndürülecek veya silinecek zaman serisi türlerinin kimliklerinin listesi.