Condividi tramite

Time Series Types - Execute Batch

  • Riferimento
Servizio:
Time Series Insights
Versione API:
2020-07-31

Esegue un'operazione get, create, update, delete in più tipi di serie temporali.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
environmentFqdn
 path True

string

FQDN per ambiente, ad esempio 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. È possibile ottenere questo nome di dominio dalla risposta dell'API Get Environments, portale di Azure o azure Resource Manager.
api-version
 query True

string

Versione dell'API da usare con la richiesta client. La versione attualmente supportata è "2020-07-31".

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-client-request-id

string

ID richiesta client facoltativo. Il servizio registra questo valore. Consente al servizio di tenere traccia dell'operazione tra i servizi e consente al cliente di contattare il supporto tecnico relativo a una richiesta specifica.
x-ms-client-session-id

string

ID sessione client facoltativo. Il servizio registra questo valore. Consente al servizio di tracciare un gruppo di operazioni correlate tra i servizi e consente al cliente di contattare il supporto tecnico relativo a un determinato gruppo di richieste.

Corpo della richiesta

Nome Tipo Descrizione
delete

TypesRequestBatchGetOrDelete

Definizione dei tipi di serie temporali da eliminare.
get

TypesRequestBatchGetOrDelete

Definizione dei tipi di serie temporali da restituire.
put

TimeSeriesType[]

Definizione dei tipi di serie temporali da aggiornare o creare.

Risposte

Nome Tipo Descrizione
200 OK

TypesBatchResponse

Operazione riuscita.

Intestazioni

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

TsiError

Errore imprevisto.

Intestazioni

x-ms-request-id: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

TypesBatchDeleteByIds
TypesBatchDeleteByNames
TypesBatchGetByIds
TypesBatchGetByNames
TypesBatchPut

TypesBatchDeleteByIds

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
200 
{
  "delete": [
    null
  ]
}

TypesBatchDeleteByNames

Esempio di richiesta

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

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

Risposta di esempio

Codice di stato:
200 
{
  "delete": [
    null
  ]
}

TypesBatchGetByIds

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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

Esempio di richiesta

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

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

Risposta di esempio

Codice di stato:
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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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
    }
  ]
}

Definizioni

Nome Descrizione
AggregateVariable

La variabile di aggregazione rappresenta qualsiasi calcolo di aggregazione. Le variabili di aggregazione non supportano l'interpolazione.
Boundary

Intervallo di tempo a sinistra e a destra dell'intervallo di ricerca da usare per l'interpolazione. Ciò è utile negli scenari in cui i punti dati mancano vicino all'inizio o alla fine dell'intervallo di ricerca di input. Può essere null.
CategoricalVariable

La variabile categorica rappresenta il segnale che deve essere analizzato in base al conteggio o alla durata dell'occorrenza di un set limitato di valori definiti.
Interpolation

Operazione di interpolazione da eseguire sui punti dati non elaborati. Attualmente è consentito solo il campionamento della serie temporale interpolata. Funzione di aggregazione consentita: ad esempio left($value). Può essere null se non deve essere applicata alcuna interpolazione.
InterpolationKind

Tipo di tecnica di interpolazione: "Lineare" o "Passaggio".
NumericVariable

Variabile numerica rappresenta un singolo segnale numerico continuo che può essere ricostruito usando l'interpolazione.
TimeSeriesAggregateCategory

Categoria utilizzata nelle variabili categoriche. Una categoria è definita da 'label' e 'values' a cui è assegnata questa etichetta.
TimeSeriesDefaultCategory

Rappresenta la categoria predefinita.
TimeSeriesType

Il tipo di serie temporali definisce variabili o formule per eseguire il calcolo sugli eventi associati alle istanze della serie temporale. Ogni istanza della serie temporale è associata esattamente a un tipo. Un tipo può avere una o più variabili. Ad esempio, un'istanza della serie temporale potrebbe essere di tipo Sensore temperatura, costituita dalle variabili temperatura media, temperatura minima e temperatura massima.
TimeSeriesTypeOrError

Risultato di un'operazione batch in un particolare tipo di serie temporali. L'oggetto Type viene impostato quando l'operazione ha esito positivo e l'oggetto errore viene impostato quando l'operazione ha esito negativo.
TsiError

Informazioni su un errore dell'API.
TsiErrorBody

Errore dell'API specifico con un codice di errore e un messaggio.
TsiErrorDetails

Informazioni aggiuntive sugli errori.
Tsx

Espressione serie temporale (TSX) scritta come singola stringa. Esempi: "$event. Status.String='Good'", "avg($event. Temperatura)". Vedere la documentazione su come scrivere espressioni di serie temporali.
TypesBatchRequest

Richiedere di eseguire una singola operazione in un batch di tipi di serie temporali. È necessario impostare esattamente uno di "get", "put" o "delete".
TypesBatchResponse

Risposta di una singola operazione in un batch di tipi di serie temporali. Verrà impostato esattamente uno di "get", "put" o "delete".
TypesRequestBatchGetOrDelete

Richiedere di ottenere o eliminare tipi di serie temporali in base agli ID o ai nomi dei tipi. È necessario impostare esattamente uno dei "typeIds" o "name".

AggregateVariable

La variabile di aggregazione rappresenta qualsiasi calcolo di aggregazione. Le variabili di aggregazione non supportano l'interpolazione.

Nome Tipo Descrizione
aggregation

Tsx

L'espressione della serie temporale di aggregazione quando il tipo è "aggregato" viene usato per rappresentare l'aggregazione che deve essere eseguita direttamente usando le proprietà dell'evento come "$event". Temperatura". Ad esempio, l'aggregazione per calcolare l'intervallo di variazioni di temperatura può essere scritta come : "max($event). Temperatura)-min($event. Temperatura)".
filter

Tsx

Filtrare gli eventi che limitano il numero di eventi da considerare per il calcolo. Esempio: "$event. Status.String='Good'". facoltativo.
kind string:

aggregate

I valori "kind" consentiti sono : "numerico" o "aggregazione". Anche se "numerico" consente di specificare il valore del segnale ricostruito e dell'espressione per aggregarli, il tipo "aggregazione" consente di aggregare direttamente le proprietà dell'evento senza specificare il valore.

Boundary

Intervallo di tempo a sinistra e a destra dell'intervallo di ricerca da usare per l'interpolazione. Ciò è utile negli scenari in cui i punti dati mancano vicino all'inizio o alla fine dell'intervallo di ricerca di input. Può essere null.

Nome Tipo Descrizione
span

string

CategoricalVariable

La variabile categorica rappresenta il segnale che deve essere analizzato in base al conteggio o alla durata dell'occorrenza di un set limitato di valori definiti.

Nome Tipo Descrizione
categories

TimeSeriesAggregateCategory[]

Categoria usata nelle variabili categoriche. Una categoria è definita da 'label' e i 'valori' assegnati a questa etichetta.
defaultCategory

TimeSeriesDefaultCategory

Rappresenta la categoria predefinita.
filter

Tsx

Filtrare gli eventi che limitano il numero di eventi da considerare per il calcolo. Esempio: "$event. Status.String='Good'". facoltativo.
interpolation

Interpolation

La variabile categorica supporta solo l'interpolazione "step".
kind string:

categorical

I valori "kind" consentiti sono : "numerico" o "aggregazione". Anche se "numerico" consente di specificare il valore del segnale ricostruito e dell'espressione per aggregarli, il tipo "aggregazione" consente di aggregare direttamente le proprietà dell'evento senza specificare il valore.
value

Tsx

L'espressione della serie temporale valore viene usata per rappresentare il valore del segnale che verrà classificato. Può valutare solo il tipo "String" o "Long" per le variabili categoriche.

Interpolation

Operazione di interpolazione da eseguire sui punti dati non elaborati. Attualmente è consentito solo il campionamento della serie temporale interpolata. Funzione di aggregazione consentita: ad esempio left($value). Può essere null se non deve essere applicata alcuna interpolazione.

Nome Tipo Descrizione
boundary

Boundary

Intervallo di tempo a sinistra e a destra dell'intervallo di ricerca da usare per l'interpolazione. Ciò è utile negli scenari in cui i punti dati mancano vicino all'inizio o alla fine dell'intervallo di ricerca di input. Può essere null.
kind

InterpolationKind

Tipo di tecnica di interpolazione: "Lineare" o "Passaggio".

InterpolationKind

Tipo di tecnica di interpolazione: "Lineare" o "Passaggio".

Nome Tipo Descrizione
Linear

string

Step

string

NumericVariable

Variabile numerica rappresenta un singolo segnale numerico continuo che può essere ricostruito usando l'interpolazione.

Nome Tipo Descrizione
aggregation

Tsx

L'espressione di serie temporali di aggregazione quando il tipo è "numerico" viene usato per rappresentare l'aggregazione che deve essere eseguita nell'espressione $value. Ciò richiede $value da specificare e può usare solo $value all'interno delle funzioni di aggregazione. Ad esempio, l'aggregazione per il calcolo minimo della $value viene scritta come : "min($value)".
filter

Tsx

Filtrare gli eventi che limitano il numero di eventi da considerare per il calcolo. Esempio: "$event. Status.String='Good'". facoltativo.
interpolation

Interpolation

Operazione di interpolazione da eseguire sui punti dati non elaborati. Attualmente è consentito solo il campionamento della serie temporale interpolata. Funzione di aggregazione consentita: ad esempio left($value). Può essere null se non deve essere applicata alcuna interpolazione.
kind string:

numeric

I valori "kind" consentiti sono : "numerico" o "aggregazione". Anche se "numerico" consente di specificare il valore del segnale ricostruito e dell'espressione per aggregarli, il tipo "aggregazione" consente di aggregare direttamente le proprietà dell'evento senza specificare il valore.
value

Tsx

L'espressione serie temporale valore viene usata per rappresentare il valore del segnale che verrà aggregato o interpolato. Ad esempio, i valori di temperatura dell'evento sono rappresentati in questo modo: "$event. Temperature.Double".

TimeSeriesAggregateCategory

Categoria utilizzata nelle variabili categoriche. Una categoria è definita da 'label' e 'values' a cui è assegnata questa etichetta.

Nome Tipo Descrizione
label

string

Nome della categoria che verrà usata per costruire i nomi delle variabili di output.
values

object[]

Elenco di valori a cui viene eseguito il mapping di una categoria. Può essere un elenco univoco di stringhe o elenco di long.

TimeSeriesDefaultCategory

Rappresenta la categoria predefinita.

Nome Tipo Descrizione
label

string

Nome della categoria predefinita che verrà assegnata ai valori che non corrispondono a quelli definiti nelle 'categorie'.

TimeSeriesType

Il tipo di serie temporali definisce variabili o formule per eseguire il calcolo sugli eventi associati alle istanze della serie temporale. Ogni istanza della serie temporale è associata esattamente a un tipo. Un tipo può avere una o più variabili. Ad esempio, un'istanza della serie temporale potrebbe essere di tipo Sensore temperatura, costituita dalle variabili temperatura media, temperatura minima e temperatura massima.

Nome Tipo Descrizione
description

string

Descrizione del tipo. Può essere Null.
id

string

Identificatore univoco con distinzione tra maiuscole e minuscole non modificabile. Può essere null per creare o aggiornare le richieste e quindi il server genera l'ID. Non null per le operazioni get ed delete.
name

string

Nome univoco specificato dall'utente per il tipo. Modificabile, non Null.
variables

object

Variabili diverse associate al tipo. Non vuoto, non Null.

TimeSeriesTypeOrError

Risultato di un'operazione batch in un particolare tipo di serie temporali. L'oggetto Type viene impostato quando l'operazione ha esito positivo e l'oggetto errore viene impostato quando l'operazione ha esito negativo.

Nome Tipo Descrizione
error

TsiErrorBody

Oggetto Errore: impostare quando l'operazione non riesce.
timeSeriesType

TimeSeriesType

Oggetto Tipo serie temporale: impostare quando l'operazione ha esito positivo.

TsiError

Informazioni su un errore dell'API.

Nome Tipo Descrizione
error

TsiErrorBody

Errore dell'API specifico con un codice di errore e un messaggio.

TsiErrorBody

Errore dell'API specifico con un codice di errore e un messaggio.

Nome Tipo Descrizione
code

string

Stringa di errore indipendente dal linguaggio e leggibile che definisce un codice di errore specifico del servizio. Questo codice funge da indicatore più specifico per il codice di errore HTTP specificato nella risposta. Può essere usato per gestire casi di errore specifici a livello di codice.
details

TsiErrorDetails[]

Contiene informazioni aggiuntive sugli errori. Può essere Null.
innerError

TsiErrorBody

Contiene un errore più specifico che restringe la causa. Può essere Null.
message

string

Rappresentazione indipendente dal linguaggio e leggibile dell'errore. È destinato agli sviluppatori e non è adatto per l'esposizione agli utenti finali.
target

string

Destinazione del particolare errore (ad esempio, il nome della proprietà in errore). Può essere Null.

TsiErrorDetails

Informazioni aggiuntive sugli errori.

Nome Tipo Descrizione
code

string

Stringa di errore indipendente dal linguaggio e leggibile che definisce un codice di errore specifico del servizio. Questo codice funge da indicatore più specifico per il codice di errore HTTP specificato nella risposta. Può essere usato per gestire casi di errore specifici a livello di codice.
message

string

Rappresentazione indipendente dal linguaggio e leggibile dell'errore. È destinato agli sviluppatori e non è adatto per l'esposizione agli utenti finali.

Tsx

Espressione serie temporale (TSX) scritta come singola stringa. Esempi: "$event. Status.String='Good'", "avg($event. Temperatura)". Vedere la documentazione su come scrivere espressioni di serie temporali.

Nome Tipo Descrizione
tsx

string

Espressione serie temporale (TSX) scritta come singola stringa. Esempi: "$event. Status.String='Good'", "avg($event. Temperatura)". Vedere la documentazione su come scrivere espressioni di serie temporali.

TypesBatchRequest

Richiedere di eseguire una singola operazione in un batch di tipi di serie temporali. È necessario impostare esattamente uno di "get", "put" o "delete".

Nome Tipo Descrizione
delete

TypesRequestBatchGetOrDelete

Definizione dei tipi di serie temporali da eliminare.
get

TypesRequestBatchGetOrDelete

Definizione dei tipi di serie temporali da restituire.
put

TimeSeriesType[]

Definizione dei tipi di serie temporali da aggiornare o creare.

TypesBatchResponse

Risposta di una singola operazione in un batch di tipi di serie temporali. Verrà impostato esattamente uno di "get", "put" o "delete".

Nome Tipo Descrizione
delete

TsiErrorBody[]

Elenco di oggetti di errore corrispondenti in base alla posizione della matrice "delete" nella richiesta - Null quando l'operazione ha esito positivo.
get

TimeSeriesTypeOrError[]

Elenco di tipi o oggetti di errore corrispondenti in base alla posizione della matrice "get" nella richiesta. L'oggetto Type viene impostato quando l'operazione ha esito positivo e l'oggetto errore viene impostato quando l'operazione ha esito negativo.
put

TimeSeriesTypeOrError[]

Elenco di tipi o oggetti di errore corrispondenti in base alla posizione della matrice "put" nella richiesta. L'oggetto Type viene impostato quando l'operazione ha esito positivo e l'oggetto errore viene impostato quando l'operazione ha esito negativo.

TypesRequestBatchGetOrDelete

Richiedere di ottenere o eliminare tipi di serie temporali in base agli ID o ai nomi dei tipi. È necessario impostare esattamente uno dei "typeIds" o "name".

Nome Tipo Descrizione
names

string[]

Elenco dei nomi dei tipi di serie temporali da restituire o eliminare.
typeIds

string[]

Elenco di ID di tipi di serie temporali da restituire o eliminare.