Event Sources - Get

Pobiera źródło zdarzeń o określonej nazwie w określonym środowisku.

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

Parametry identyfikatora URI

Name In Required Type Description
environmentName
path True
  • string

Nazwa środowiska Szczegółowe informacje szeregów czasowych skojarzonych z określoną grupą zasobów.

eventSourceName
path True
  • string

Nazwa źródła zdarzeń Szczegółowe informacje szeregów czasowych skojarzonych z określonym środowiskiem.

resourceGroupName
path True
  • string

Nazwa grupy zasobów platformy Azure.

subscriptionId
path True
  • string

Identyfikator subskrypcji platformy Azure.

api-version
query True
  • string

Wersja interfejsu API do użycia z żądaniem klienta.

Odpowiedzi

Name Type Description
200 OK EventSourceResource:

Definicja źródła zdarzeń została pomyślnie pobrana i znajduje się w odpowiedzi.

Other Status Codes

HTTP 404 (Nie znaleziono): nie można odnaleźć subskrypcji, grupy zasobów, środowiska lub źródła zdarzeń.

Zabezpieczenia

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 personifikacja konta użytkownika

Przykłady

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

Definicje

CloudError

Zawiera informacje o błędzie interfejsu API.

CloudErrorBody

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

EventHubEventSourceResource

Źródło zdarzeń, które odbiera dane z usługi Azure EventHub.

IngressStartAtType

Typ ruchu przychodzącegoStartAt, może to być "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

IoTHubEventSourceResource

Źródło zdarzeń, które odbiera dane z usługi Azure IoTHub.

LocalTimestamp

Obiekt reprezentujący lokalną właściwość znacznika czasu. Zawiera format lokalnego znacznika czasu, który musi być używany i odpowiednie informacje dotyczące przesunięcia strefy czasowej. Jeśli wartość nie zostanie określona dla elementu localTimestamp lub jeśli ma wartość null, znacznik czasu lokalnego nie będzie przychodzący ze zdarzeniami.

LocalTimestampFormat

Wyliczenie reprezentujące format właściwości sygnatury czasowej lokalnej, która musi zostać ustawiona.

ProvisioningState

Stan aprowizacji zasobu.

TimeZoneOffset

Obiekt reprezentujący informacje przesunięcia dla określonego lokalnego formatu znacznika czasu. Nie należy określać parametru LocalTimestampFormat — Embedded.

CloudError

Zawiera informacje o błędzie interfejsu API.

Name Type Description
error

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

CloudErrorBody

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

Name Type Description
code
  • string

Kod błędu opisujący warunek błędu dokładniej niż kod stanu HTTP. Może służyć do programowego obsługi określonych przypadków błędów.

details

Zawiera zagnieżdżone błędy związane z tym błędem.

message
  • string

Komunikat opisujący szczegółowo błąd i zawierający informacje dotyczące debugowania.

target
  • string

Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie).

EventHubEventSourceResource

Źródło zdarzeń, które odbiera dane z usługi Azure EventHub.

Name Type Description
creationTime
  • string

Czas utworzenia zasobu.

eventSourceResourceId
  • string

Identyfikator zasobu źródła zdarzeń w usłudze Azure Resource Manager.

id
  • string

Identyfikator zasobu

ingressStartAt.time
  • string

ISO8601 UTC data/godzina z dokładnością sekund (milisekundy są opcjonalne), określając datę i godzinę, która będzie punktem początkowym dla zdarzeń, które mają być używane.

ingressStartAt.type

Typ ruchu przychodzącegoStartAt, może to być "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

kind string:
  • Microsoft.EventHub

Rodzaj źródła zdarzeń.

localTimestamp

Obiekt reprezentujący lokalną właściwość znacznika czasu. Zawiera format lokalnego znacznika czasu, który musi być używany i odpowiednie informacje dotyczące przesunięcia strefy czasowej. Jeśli wartość nie zostanie określona dla elementu localTimestamp lub jeśli ma wartość null, znacznik czasu lokalnego nie będzie przychodzący ze zdarzeniami.

location
  • string

Lokalizacja zasobu

name
  • string

Nazwa zasobu

properties.consumerGroupName
  • string

Nazwa grupy odbiorców centrum zdarzeń, która zawiera partycje, z których będą odczytywane zdarzenia.

properties.eventHubName
  • string

Nazwa centrum zdarzeń.

properties.keyName
  • string

Nazwa klucza sygnatury dostępu współdzielonego, który przyznaje usłudze Time Series Szczegółowe informacje dostęp do centrum zdarzeń. Zasady dostępu współdzielonego dla tego klucza muszą udzielić uprawnień "Nasłuchiwanie" do centrum zdarzeń.

properties.serviceBusNamespace
  • string

Nazwa magistrali usług, która zawiera centrum zdarzeń.

provisioningState

Stan aprowizacji zasobu.

tags
  • object

Tagi zasobów

timestampPropertyName
  • string

Właściwość zdarzenia, która będzie używana jako sygnatura czasowa źródła zdarzeń. Jeśli wartość nie jest określona dla parametru timestampPropertyName lub jeśli określono wartość null lub pusty ciąg, zostanie użyty czas tworzenia zdarzenia.

type
  • string

Typ zasobu

IngressStartAtType

Typ ruchu przychodzącegoStartAt, może to być "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

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

IoTHubEventSourceResource

Źródło zdarzeń, które odbiera dane z usługi Azure IoTHub.

Name Type Description
creationTime
  • string

Czas utworzenia zasobu.

eventSourceResourceId
  • string

Identyfikator zasobu źródła zdarzeń w usłudze Azure Resource Manager.

id
  • string

Identyfikator zasobu

ingressStartAt.time
  • string

ISO8601 UTC data/godzina z dokładnością sekund (milisekundy są opcjonalne), określając datę i godzinę, która będzie punktem początkowym dla zdarzeń, które mają być używane.

ingressStartAt.type

Typ ruchu przychodzącegoStartAt, może to być "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

kind string:
  • Microsoft.IoTHub

Rodzaj źródła zdarzeń.

localTimestamp

Obiekt reprezentujący lokalną właściwość znacznika czasu. Zawiera format lokalnego znacznika czasu, który musi być używany i odpowiednie informacje dotyczące przesunięcia strefy czasowej. Jeśli wartość nie zostanie określona dla elementu localTimestamp lub jeśli ma wartość null, znacznik czasu lokalnego nie będzie przychodzący ze zdarzeniami.

location
  • string

Lokalizacja zasobu

name
  • string

Nazwa zasobu

properties.consumerGroupName
  • string

Nazwa grupy odbiorców centrum iot, która zawiera partycje, z których będą odczytywane zdarzenia.

properties.iotHubName
  • string

Nazwa centrum iot.

properties.keyName
  • string

Nazwa klucza zasad dostępu współdzielonego, który przyznaje usłudze Time Series Szczegółowe informacje dostęp do centrum iot. Ten klucz zasad dostępu współdzielonego musi udzielić uprawnień "service connect" do centrum iot.

provisioningState

Stan aprowizacji zasobu.

tags
  • object

Tagi zasobów

timestampPropertyName
  • string

Właściwość zdarzenia, która będzie używana jako sygnatura czasowa źródła zdarzeń. Jeśli wartość nie jest określona dla parametru timestampPropertyName lub jeśli określono wartość null lub pusty ciąg, zostanie użyty czas tworzenia zdarzenia.

type
  • string

Typ zasobu

LocalTimestamp

Obiekt reprezentujący lokalną właściwość znacznika czasu. Zawiera format lokalnego znacznika czasu, który musi być używany i odpowiednie informacje dotyczące przesunięcia strefy czasowej. Jeśli wartość nie zostanie określona dla elementu localTimestamp lub jeśli ma wartość null, znacznik czasu lokalnego nie będzie przychodzący ze zdarzeniami.

Name Type Description
format

Wyliczenie reprezentujące format właściwości sygnatury czasowej lokalnej, która musi zostać ustawiona.

timeZoneOffset

Obiekt reprezentujący informacje przesunięcia dla określonego lokalnego formatu znacznika czasu. Nie należy określać parametru LocalTimestampFormat — Embedded.

LocalTimestampFormat

Wyliczenie reprezentujące format właściwości sygnatury czasowej lokalnej, która musi zostać ustawiona.

Name Type Description
Embedded
  • string

ProvisioningState

Stan aprowizacji zasobu.

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

TimeZoneOffset

Obiekt reprezentujący informacje przesunięcia dla określonego lokalnego formatu znacznika czasu. Nie należy określać parametru LocalTimestampFormat — Embedded.

Name Type Description
propertyName
  • string

Właściwość zdarzenia, która będzie zawierać informacje przesunięcia, aby obliczyć lokalny znacznik czasu. Gdy parametr LocalTimestampFormat to Iana, nazwa właściwości będzie zawierać nazwę kolumny zawierającej nazwę strefy czasowej IANA (np. Americas/Los Angeles). Gdy Parametr LocalTimestampFormat to Timespan, zawiera nazwę właściwości, która zawiera wartości reprezentujące przesunięcie (np. P1D lub 1.00:00:00)