Event Sources - Get

Lekéri a megadott nevű eseményforrást a megadott környezetben.

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

URI-paraméterek

Name In Required Type Description
environmentName
path True
  • string

A megadott erőforráscsoporthoz társított idősor Elemzések környezet neve.

eventSourceName
path True
  • string

Az idősor neve Elemzések adott környezethez társított eseményforrás.

resourceGroupName
path True
  • string

Egy Azure-erőforráscsoport neve.

subscriptionId
path True
  • string

Azure-előfizetés azonosítója.

api-version
query True
  • string

Az ügyfélkéréshez használandó API verziója.

Válaszok

Name Type Description
200 OK EventSourceResource:

Az eseményforrás definíciójának lekérése sikerült, és a válaszban szerepel.

Other Status Codes

HTTP 404 (Nem található): Az előfizetés, az erőforráscsoport, a környezet vagy az eseményforrás nem található.

Biztonság

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 felhasználói fiók megszemélyesítése

Példák

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

Definíciók

CloudError

API-hibával kapcsolatos információkat tartalmaz.

CloudErrorBody

Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.

EventHubEventSourceResource

Egy eseményforrás, amely az adatait egy Azure EventHubról fogadja.

IngressStartAtType

Az ingressStartAt típusa lehet "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

IoTHubEventSourceResource

Eseményforrás, amely az adatait egy Azure IoTHubról fogadja.

LocalTimestamp

Egy objektum, amely a helyi időbélyeg tulajdonságot jelöli. Tartalmazza a használni kívánt helyi időbélyeg formátumát és a megfelelő időzónia-eltolási információkat. Ha nincs megadva érték a localTimestamp paraméterhez, vagy ha null, akkor a helyi időbélyeg nem kerül be az eseményekbe.

LocalTimestampFormat

Egy enumerálás, amely a beállítani kívánt helyi időbélyeg-tulajdonság formátumát jelöli.

ProvisioningState

Az erőforrás kiépítési állapota.

TimeZoneOffset

Egy objektum, amely a megadott helyi időbélyegformátum eltolásadatait jelöli. A LocalTimestampFormat – Embedded paraméterhez nem adható meg.

CloudError

API-hibával kapcsolatos információkat tartalmaz.

Name Type Description
error

Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.

CloudErrorBody

Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.

Name Type Description
code
  • string

Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaesetek programozott kezelésére használható.

details

Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.

message
  • string

A hibát részletesen leíró és hibakeresési információkat tartalmazó üzenet.

target
  • string

Az adott hiba célja (például a hibás tulajdonság neve).

EventHubEventSourceResource

Egy eseményforrás, amely az adatait egy Azure EventHubról fogadja.

Name Type Description
creationTime
  • string

Az erőforrás létrehozásának időpontja.

eventSourceResourceId
  • string

Az Azure Resource Manager eseményforrásának erőforrás-azonosítója.

id
  • string

Erőforrás-azonosító

ingressStartAt.time
  • string

ISO8601 UTC dátum/idő másodperc pontossággal (ezredmásodperc nem kötelező), megadva azt a dátumot és időt, amely a felhasználandó események kiindulópontja lesz.

ingressStartAt.type

Az ingressStartAt típusa lehet "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

kind string:
  • Microsoft.EventHub

Az eseményforrás típusa.

localTimestamp

Egy objektum, amely a helyi időbélyeg tulajdonságot jelöli. Tartalmazza a használni kívánt helyi időbélyeg formátumát és a megfelelő időzónia-eltolási információkat. Ha nincs megadva érték a localTimestamp paraméterhez, vagy ha null, akkor a helyi időbélyeg nem kerül be az eseményekbe.

location
  • string

Erőforrás helye

name
  • string

Erőforrás neve

properties.consumerGroupName
  • string

Az eseményközpont azon fogyasztói csoportjának neve, amely tartalmazza azokat a partíciókat, amelyekből az eseményeket beolvassák.

properties.eventHubName
  • string

Az eseményközpont neve.

properties.keyName
  • string

A Time Series Elemzések szolgáltatásnak az eseményközponthoz való hozzáférését biztosító SAS-kulcs neve. A kulcs megosztott hozzáférési szabályzatainak "Figyelés" engedélyeket kell adniuk az eseményközpontnak.

properties.serviceBusNamespace
  • string

Az eseményközpontot tartalmazó service bus neve.

provisioningState

Az erőforrás kiépítési állapota.

tags
  • object

Erőforráscímkék

timestampPropertyName
  • string

Az eseményforrás időbélyegeként használt eseménytulajdonság. Ha nincs megadva érték a timestampPropertyName paraméterhez, vagy ha null vagy üres sztring van megadva, a rendszer az eseménylétrehozás idejét fogja használni.

type
  • string

Erőforrás típusa

IngressStartAtType

Az ingressStartAt típusa lehet "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

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

IoTHubEventSourceResource

Eseményforrás, amely az adatait egy Azure IoTHubról fogadja.

Name Type Description
creationTime
  • string

Az erőforrás létrehozásának időpontja.

eventSourceResourceId
  • string

Az Azure Resource Manager eseményforrásának erőforrás-azonosítója.

id
  • string

Erőforrás-azonosító

ingressStartAt.time
  • string

ISO8601 UTC dátum/idő másodperc pontossággal (ezredmásodperc nem kötelező), megadva azt a dátumot és időt, amely a felhasználandó események kiindulópontja lesz.

ingressStartAt.type

Az ingressStartAt típusa lehet "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

kind string:
  • Microsoft.IoTHub

Az eseményforrás típusa.

localTimestamp

Egy objektum, amely a helyi időbélyeg tulajdonságot jelöli. Tartalmazza a használni kívánt helyi időbélyeg formátumát és a megfelelő időzónia-eltolási információkat. Ha nincs megadva érték a localTimestamp paraméterhez, vagy ha null, akkor a helyi időbélyeg nem kerül be az eseményekbe.

location
  • string

Erőforrás helye

name
  • string

Erőforrás neve

properties.consumerGroupName
  • string

Az iot hub azon fogyasztói csoportjának neve, amely tartalmazza azokat a partíciókat, amelyekből az eseményeket beolvassa a rendszer.

properties.iotHubName
  • string

Az iot hub neve.

properties.keyName
  • string

Annak a megosztott hozzáférésű hozzáférési szabályzatkulcsnak a neve, amely hozzáférést biztosít az idősor Elemzések szolgáltatásnak az iot hubhoz. Ennek a megosztott hozzáférési szabályzatkulcsnak "service connect" engedélyeket kell adnia az iot hubnak.

provisioningState

Az erőforrás kiépítési állapota.

tags
  • object

Erőforráscímkék

timestampPropertyName
  • string

Az eseményforrás időbélyegeként használt eseménytulajdonság. Ha nincs megadva érték a timestampPropertyName paraméterhez, vagy ha null vagy üres sztring van megadva, a rendszer az eseménylétrehozás idejét fogja használni.

type
  • string

Erőforrás típusa

LocalTimestamp

Egy objektum, amely a helyi időbélyeg tulajdonságot jelöli. Tartalmazza a használni kívánt helyi időbélyeg formátumát és a megfelelő időzónia-eltolási információkat. Ha nincs megadva érték a localTimestamp paraméterhez, vagy ha null, akkor a helyi időbélyeg nem kerül be az eseményekbe.

Name Type Description
format

Egy enumerálás, amely a beállítani kívánt helyi időbélyeg-tulajdonság formátumát jelöli.

timeZoneOffset

Egy objektum, amely a megadott helyi időbélyegformátum eltolásadatait jelöli. A LocalTimestampFormat – Embedded paraméterhez nem adható meg.

LocalTimestampFormat

Egy enumerálás, amely a beállítani kívánt helyi időbélyeg-tulajdonság formátumát jelöli.

Name Type Description
Embedded
  • string

ProvisioningState

Az erőforrás kiépítési állapota.

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

TimeZoneOffset

Egy objektum, amely a megadott helyi időbélyegformátum eltolásadatait jelöli. A LocalTimestampFormat – Embedded paraméterhez nem adható meg.

Name Type Description
propertyName
  • string

A helyi időbélyeg kiszámításához szükséges eltolásadatokat tartalmazó eseménytulajdonság. Ha a LocalTimestampFormat értéke Iana, a tulajdonság neve tartalmazni fogja annak az oszlopnak a nevét, amely tartalmazza az IANA időzóna nevét (például: Americas/Los Angeles). Ha a LocalTimestampFormat időbélyegző, akkor annak a tulajdonságnak a nevét tartalmazza, amely az eltolást jelölő értékeket tartalmazza (pl. P1D vagy 1.00:00:00)