Query - Get Event Schema
Retourneert het gebeurtenisschema van de omgeving voor een bepaald zoekbereik. Gebeurtenisschema is een set eigenschapsdefinities. Het gebeurtenisschema bevat mogelijk niet alle persistente eigenschappen wanneer er te veel eigenschappen zijn.
POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31
POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31&storeType={storeType}
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
environment
|
path | True |
string |
FQDN per omgeving, bijvoorbeeld 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. U kunt deze domeinnaam verkrijgen uit het antwoord van de API Get Environments, Azure Portal of Azure Resource Manager. |
api-version
|
query | True |
string |
Versie van de API die moet worden gebruikt met de clientaanvraag. De momenteel ondersteunde versie is 2020-07-31. |
store
|
query |
string |
Voor de omgevingen waarvoor Warm Store is ingeschakeld, kan de query worden uitgevoerd op de 'WarmStore' of 'ColdStore'. Deze parameter in de query definieert op welk archief de query moet worden uitgevoerd. Als deze niet is gedefinieerd, wordt de query uitgevoerd op het koelarchief. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
x-ms-client-request-id |
string |
Optionele clientaanvraag-id. Service registreert deze waarde. Hiermee kan de service de werking van verschillende services traceren en kan de klant contact opnemen met de ondersteuning met betrekking tot een bepaalde aanvraag. |
|
x-ms-client-session-id |
string |
Optionele clientsessie-id. Service registreert deze waarde. Hiermee kan de service een groep gerelateerde bewerkingen in verschillende services traceren en kan de klant contact opnemen met ondersteuning met betrekking tot een bepaalde groep aanvragen. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
searchSpan | True |
Het tijdsbereik waarop de query wordt uitgevoerd. Kan niet null zijn. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Geslaagde bewerking. Kopteksten x-ms-request-id: string |
|
Other Status Codes |
Onverwachte fout. Kopteksten x-ms-request-id: string |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | uw gebruikersaccount imiteren |
Voorbeelden
Cold |
Event |
Event |
Warm |
ColdStoreEventSchemaGet
Voorbeeldaanvraag
POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=coldstore
{
"searchSpan": {
"from": "2018-08-01T00:00:00.000Z",
"to": "2018-08-31T00:00:00.000Z"
}
}
Voorbeeldrespons
{
"properties": [
{
"name": "Building",
"type": "String"
},
{
"name": "Room",
"type": "String"
},
{
"name": "DeviceId",
"type": "Double"
},
{
"name": "Temperature",
"type": "Double"
},
{
"name": "Pressure",
"type": "Double"
},
{
"name": "Status",
"type": "String"
}
]
}
EventSchemaGet
Voorbeeldaanvraag
POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31
{
"searchSpan": {
"from": "2018-08-01T00:00:00.000Z",
"to": "2018-08-31T00:00:00.000Z"
}
}
Voorbeeldrespons
{
"properties": [
{
"name": "Building",
"type": "String"
},
{
"name": "Room",
"type": "String"
},
{
"name": "DeviceId",
"type": "Double"
},
{
"name": "Temperature",
"type": "Double"
},
{
"name": "Pressure",
"type": "Double"
},
{
"name": "Status",
"type": "String"
}
]
}
EventSchemaGetEmpty
Voorbeeldaanvraag
POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31
{
"searchSpan": {
"from": "2016-08-01T00:00:00.000Z",
"to": "2016-08-31T00:00:00.000Z"
}
}
Voorbeeldrespons
{
"properties": []
}
WarmStoreEventSchemaGet
Voorbeeldaanvraag
POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=warmstore
{
"searchSpan": {
"from": "2018-08-01T00:00:00.000Z",
"to": "2018-08-31T00:00:00.000Z"
}
}
Voorbeeldrespons
{
"properties": [
{
"name": "Building",
"type": "String"
},
{
"name": "Room",
"type": "String"
},
{
"name": "DeviceId",
"type": "Double"
},
{
"name": "Temperature",
"type": "Double"
},
{
"name": "Pressure",
"type": "Double"
},
{
"name": "Status",
"type": "String"
}
]
}
Definities
Name | Description |
---|---|
Date |
Het tijdsbereik. Kan niet null of negatief zijn. |
Event |
Eigenschap van een gebeurtenis die wordt opgeslagen of berekend. Eigenschappen worden geïdentificeerd met zowel naam als type. Verschillende gebeurtenissen kunnen eigenschappen hebben met dezelfde naam, maar met een ander type. |
Event |
Gebeurtenisschema van alle gebeurtenissen binnen een bepaald zoekbereik. Gebeurtenisschema is een set eigenschapsdefinities. Eigenschappen worden geïdentificeerd met zowel naam als type. Verschillende gebeurtenissen kunnen eigenschappen hebben met dezelfde naam, maar met een ander type. Het gebeurtenisschema bevat mogelijk niet alle persistente eigenschappen wanneer er te veel eigenschappen zijn. |
Get |
Aanvraag om het gebeurtenisschema van alle gebeurtenissen binnen een bepaald zoekbereik op te halen. |
Property |
Het type van de eigenschap. |
Tsi |
Informatie over een API-fout. |
Tsi |
Een bepaalde API-fout met een foutcode en een bericht. |
Tsi |
Aanvullende foutinformatie. |
DateTimeRange
Het tijdsbereik. Kan niet null of negatief zijn.
Name | Type | Description |
---|---|---|
from |
string |
Begintijdstempel van het tijdsbereik. Het begintijdstempel is inclusief wanneer deze wordt gebruikt in queryaanvragen voor tijdreeksen. Gebeurtenissen met deze tijdstempel worden opgenomen. |
to |
string |
Eindtijdstempel van het tijdsbereik. Eindtijdstempel is exclusief bij gebruik in tijdreeksqueryaanvragen. Gebeurtenissen die overeenkomen met deze tijdstempel worden uitgesloten. Houd er rekening mee dat de eindtijdstempel inclusief is wanneer deze wordt geretourneerd door Beschikbaarheid ophalen (wat betekent dat er een gebeurtenis is met deze exacte 'to'-tijdstempel). |
EventProperty
Eigenschap van een gebeurtenis die wordt opgeslagen of berekend. Eigenschappen worden geïdentificeerd met zowel naam als type. Verschillende gebeurtenissen kunnen eigenschappen hebben met dezelfde naam, maar met een ander type.
Name | Type | Description |
---|---|---|
name |
string |
De naam van de eigenschap. |
type |
Het type van de eigenschap. |
EventSchema
Gebeurtenisschema van alle gebeurtenissen binnen een bepaald zoekbereik. Gebeurtenisschema is een set eigenschapsdefinities. Eigenschappen worden geïdentificeerd met zowel naam als type. Verschillende gebeurtenissen kunnen eigenschappen hebben met dezelfde naam, maar met een ander type. Het gebeurtenisschema bevat mogelijk niet alle persistente eigenschappen wanneer er te veel eigenschappen zijn.
Name | Type | Description |
---|---|---|
properties |
Een set eigenschapsdefinities. Wanneer de omgeving geen gegevens bevat, is de geretourneerde matrix leeg. |
GetEventSchemaRequest
Aanvraag om het gebeurtenisschema van alle gebeurtenissen binnen een bepaald zoekbereik op te halen.
Name | Type | Description |
---|---|---|
searchSpan |
Het tijdsbereik waarop de query wordt uitgevoerd. Kan niet null zijn. |
PropertyTypes
Het type van de eigenschap.
Name | Type | Description |
---|---|---|
Bool |
string |
|
DateTime |
string |
|
Double |
string |
|
Long |
string |
|
String |
string |
|
TimeSpan |
string |
TsiError
Informatie over een API-fout.
Name | Type | Description |
---|---|---|
error |
Een bepaalde API-fout met een foutcode en een bericht. |
TsiErrorBody
Een bepaalde API-fout met een foutcode en een bericht.
Name | Type | Description |
---|---|---|
code |
string |
Taalonafhankelijke, door mensen leesbare tekenreeks die een servicespecifieke foutcode definieert. Deze code fungeert als een specifiekere indicator voor de HTTP-foutcode die is opgegeven in het antwoord. Kan worden gebruikt voor het programmatisch afhandelen van specifieke foutgevallen. |
details |
Bevat aanvullende foutinformatie. Kan null zijn. |
|
innerError |
Bevat een specifiekere fout die de oorzaak beperkt. Kan null zijn. |
|
message |
string |
Door de mens leesbare, taalonafhankelijke weergave van de fout. Het is bedoeld als hulpmiddel voor ontwikkelaars en is niet geschikt voor blootstelling aan eindgebruikers. |
target |
string |
Doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout). Kan null zijn. |
TsiErrorDetails
Aanvullende foutinformatie.
Name | Type | Description |
---|---|---|
code |
string |
Taalonafhankelijke, door mensen leesbare tekenreeks die een servicespecifieke foutcode definieert. Deze code fungeert als een specifiekere indicator voor de HTTP-foutcode die is opgegeven in het antwoord. Kan worden gebruikt voor het programmatisch afhandelen van specifieke foutgevallen. |
message |
string |
Door de mens leesbare, taalonafhankelijke weergave van de fout. Het is bedoeld als hulpmiddel voor ontwikkelaars en is niet geschikt voor blootstelling aan eindgebruikers. |