Event Sources - Get

Ruft die Ereignisquelle mit dem angegebenen Namen in der angegebenen Umgebung ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/eventSources/{eventSourceName}?api-version=2020-05-15

URI-Parameter

Name In Required Type Description
environmentName
path True
  • string

Der Name der Zeitreihe Insights Umgebung, die der angegebenen Ressourcengruppe zugeordnet ist.

eventSourceName
path True
  • string

Der Name der Zeitreihe Insights Ereignisquelle, die der angegebenen Umgebung zugeordnet ist.

resourceGroupName
path True
  • string

Name einer Azure-Ressourcengruppe.

subscriptionId
path True
  • string

Die Azure-Abonnement-ID.

api-version
query True
  • string

Version der API, die mit der Clientanforderung verwendet werden soll.

Antworten

Name Type Description
200 OK EventSourceResource:

Die Ereignisquelledefinition wurde erfolgreich abgerufen und befindet sich in der Antwort.

Other Status Codes

HTTP 404 (Nicht gefunden): Das Abonnement, die Ressourcengruppe, die Umgebung oder die Ereignisquelle konnte nicht gefunden werden.

Sicherheit

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 Identitätswechsel Ihres Benutzerkontos

Beispiele

GetEventHubEventSource

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/environments/env1/eventSources/es1?api-version=2020-05-15

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1",
  "location": "West US",
  "name": "es1",
  "type": "Microsoft.TimeSeriesInsights/Environments/EventSources",
  "tags": {},
  "kind": "Microsoft.EventHub",
  "properties": {
    "eventSourceResourceId": "somePathInArm",
    "serviceBusNamespace": "sbn",
    "consumerGroupName": "cgn",
    "eventHubName": "ehn",
    "keyName": "managementKey",
    "provisioningState": "Succeeded",
    "creationTime": "2017-04-18T19:20:33.2288820Z",
    "localTimestamp": {
      "format": "TimeSpan",
      "timeZoneOffset": {
        "propertyName": "someEventPropertyName"
      }
    },
    "ingressStartAt": {
      "type": "EarliestAvailable"
    }
  }
}

Definitionen

CloudError

Enthält Informationen zu einem API-Fehler.

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Nachricht.

EventHubEventSourceResource

Eine Ereignisquelle, die ihre Daten aus einem Azure EventHub empfängt.

IngressStartAtType

Der Typ des ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

IoTHubEventSourceResource

Eine Ereignisquelle, die ihre Daten aus einem Azure IoTHub empfängt.

LocalTimestamp

Ein Objekt, das die lokale Timestamp-Eigenschaft darstellt. Es enthält das Format des lokalen Zeitstempels, der verwendet werden muss und die entsprechenden Timezone-Offsetinformationen. Wenn ein Wert nicht für localTimestamp angegeben ist oder null, wird der lokale Zeitstempel nicht mit den Ereignissen in verbindung gesetzt.

LocalTimestampFormat

Eine Aufzählung, die das Format der lokalen Timestamp-Eigenschaft darstellt, die festgelegt werden muss.

ProvisioningState

Bereitstellungsstatus der Ressource.

TimeZoneOffset

Ein Objekt, das die Offsetinformationen für das angegebene Zeitstempelformat darstellt. Sollte für LocalTimestampFormat - Eingebettet nicht angegeben werden.

CloudError

Enthält Informationen zu einem API-Fehler.

Name Type Description
error

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Nachricht.

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Nachricht.

Name Type Description
code
  • string

Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-Statuscode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.

details

Enthält geschachtelte Fehler, die sich auf diesen Fehler beziehen.

message
  • string

Eine Meldung, die den Fehler ausführlich beschreibt und Debuginformationen bereitstellt.

target
  • string

Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

EventHubEventSourceResource

Eine Ereignisquelle, die ihre Daten aus einem Azure EventHub empfängt.

Name Type Description
creationTime
  • string

Die Zeit, zu der die Ressource erstellt wurde.

eventSourceResourceId
  • string

Die Ressourcen-ID der Ereignisquelle in Azure Resource Manager.

id
  • string

Ressourcen-ID

ingressStartAt.time
  • string

ISO8601 UTC-Datumszeit mit Sekundengenauigkeit (Millisekunden sind optional), geben Sie das Datum und die Uhrzeit an, die für Ereignisse verwendet werden soll.

ingressStartAt.type

Der Typ des ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

kind string:
  • Microsoft.EventHub

Die Art der Ereignisquelle.

localTimestamp

Ein Objekt, das die lokale Timestamp-Eigenschaft darstellt. Es enthält das Format des lokalen Zeitstempels, der verwendet werden muss und die entsprechenden Timezone-Offsetinformationen. Wenn ein Wert nicht für localTimestamp angegeben ist oder null, wird der lokale Zeitstempel nicht mit den Ereignissen in verbindung gesetzt.

location
  • string

Ressourcenspeicherort

name
  • string

Ressourcenname

properties.consumerGroupName
  • string

Der Name der Verbrauchergruppe des Ereignishubs, die die Partitionen enthält, aus denen Ereignisse gelesen werden.

properties.eventHubName
  • string

Der Name des Event Hubs.

properties.keyName
  • string

Der Name des SAS-Schlüssels, der die Zeitreihe Insights Dienstzugriff auf den Ereignishub gewährt. Die Richtlinien für den freigegebenen Zugriff für diesen Schlüssel müssen "Listen"-Berechtigungen für den Ereignishub erteilen.

properties.serviceBusNamespace
  • string

Der Name des Dienstbus, der den Ereignishub enthält.

provisioningState

Bereitstellungsstatus der Ressource.

tags
  • object

Ressourcentags

timestampPropertyName
  • string

Die Ereigniseigenschaft, die als Zeitstempel der Ereignisquelle verwendet wird. Wenn für timestampPropertyName kein Name oder wenn Null oder eine leere Zeichenfolge angegeben wird, wird der Zeitpunkt der Ereigniserstellung verwendet.

type
  • string

Ressourcentyp

IngressStartAtType

Der Typ des ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

Name Type Description
CustomEnqueuedTime
  • string
EarliestAvailable
  • string
EventSourceCreationTime
  • string

IoTHubEventSourceResource

Eine Ereignisquelle, die ihre Daten aus einem Azure IoTHub empfängt.

Name Type Description
creationTime
  • string

Die Zeit, zu der die Ressource erstellt wurde.

eventSourceResourceId
  • string

Die Ressourcen-ID der Ereignisquelle in Azure Resource Manager.

id
  • string

Ressourcen-ID

ingressStartAt.time
  • string

ISO8601 UTC-Datumszeit mit Sekundengenauigkeit (Millisekunden sind optional), geben Sie das Datum und die Uhrzeit an, die für Ereignisse verwendet werden soll.

ingressStartAt.type

Der Typ des ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

kind string:
  • Microsoft.IoTHub

Die Art der Ereignisquelle.

localTimestamp

Ein Objekt, das die lokale Timestamp-Eigenschaft darstellt. Es enthält das Format des lokalen Zeitstempels, der verwendet werden muss und die entsprechenden Timezone-Offsetinformationen. Wenn ein Wert nicht für localTimestamp angegeben ist oder null, wird der lokale Zeitstempel nicht mit den Ereignissen in verbindung gesetzt.

location
  • string

Ressourcenspeicherort

name
  • string

Ressourcenname

properties.consumerGroupName
  • string

Der Name der Verbrauchergruppe des iot Hubs, die die Partitionen enthält, aus denen Ereignisse gelesen werden.

properties.iotHubName
  • string

Der Name des iot-Hubs.

properties.keyName
  • string

Der Name des Schlüssels für den freigegebenen Zugriff, der die Zeitreihe Insights Dienstzugriff auf den Iot-Hub gewährt. Dieser Schlüssel für den freigegebenen Zugriff muss "Service Connect"-Berechtigungen für den iot-Hub erteilen.

provisioningState

Bereitstellungsstatus der Ressource.

tags
  • object

Ressourcentags

timestampPropertyName
  • string

Die Ereigniseigenschaft, die als Zeitstempel der Ereignisquelle verwendet wird. Wenn für timestampPropertyName kein Name oder wenn Null oder eine leere Zeichenfolge angegeben wird, wird der Zeitpunkt der Ereigniserstellung verwendet.

type
  • string

Ressourcentyp

LocalTimestamp

Ein Objekt, das die lokale Timestamp-Eigenschaft darstellt. Es enthält das Format des lokalen Zeitstempels, der verwendet werden muss und die entsprechenden Timezone-Offsetinformationen. Wenn ein Wert nicht für localTimestamp angegeben ist oder null, wird der lokale Zeitstempel nicht mit den Ereignissen in verbindung gesetzt.

Name Type Description
format

Eine Aufzählung, die das Format der lokalen Timestamp-Eigenschaft darstellt, die festgelegt werden muss.

timeZoneOffset

Ein Objekt, das die Offsetinformationen für das angegebene Zeitstempelformat darstellt. Sollte für LocalTimestampFormat - Eingebettet nicht angegeben werden.

LocalTimestampFormat

Eine Aufzählung, die das Format der lokalen Timestamp-Eigenschaft darstellt, die festgelegt werden muss.

Name Type Description
Embedded
  • string

ProvisioningState

Bereitstellungsstatus der Ressource.

Name Type Description
Accepted
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

TimeZoneOffset

Ein Objekt, das die Offsetinformationen für das angegebene Zeitstempelformat darstellt. Sollte für LocalTimestampFormat - Eingebettet nicht angegeben werden.

Name Type Description
propertyName
  • string

Die Ereigniseigenschaft, die die Offsetinformationen enthält, um den lokalen Zeitstempel zu berechnen. Wenn das LocalTimestampFormat Iana ist, enthält der Eigenschaftsname den Namen der Spalte, die IANA Timezone Name enthält (z. B. Amerikas/Los Angeles). Wenn LocalTimestampFormat Timespan ist, enthält sie den Namen der Eigenschaft, die Werte enthält, die den Offset darstellen (z. B. P1D oder 1.00:00:00)