Event Sources - Get

Mendapatkan sumber peristiwa dengan nama yang ditentukan di lingkungan yang ditentukan.

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

Parameter URI

Name In Required Type Description
environmentName
path True
  • string

Nama lingkungan Time Series Insights yang terkait dengan grup sumber daya yang ditentukan.

eventSourceName
path True
  • string

Nama sumber peristiwa Time Series Insights yang terkait dengan lingkungan yang ditentukan.

resourceGroupName
path True
  • string

Nama grup Sumber Daya Azure.

subscriptionId
path True
  • string

ID Langganan Azure.

api-version
query True
  • string

Versi API yang akan digunakan dengan permintaan klien.

Respons

Name Type Description
200 OK EventSourceResource:

Definisi sumber kejadian berhasil diambil dan berada dalam respons.

Other Status Codes

HTTP 404 (Tidak Ditemukan): Langganan, grup sumber daya, lingkungan, atau sumber kejadian tidak dapat ditemukan.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

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

Definisi

CloudError

Berisi informasi tentang kesalahan API.

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

EventHubEventSourceResource

Sumber kejadian yang menerima datanya dari Azure EventHub.

IngressStartAtType

Jenis ingressStartAt, Dapat berupa "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

IoTHubEventSourceResource

Sumber peristiwa yang menerima datanya dari Azure IoTHub.

LocalTimestamp

Objek yang mewakili properti tanda waktu lokal. Ini berisi format tanda waktu lokal yang perlu digunakan dan informasi offset zona waktu yang sesuai. Jika nilai tidak ditentukan untuk localTimestamp, atau jika null, maka tanda waktu lokal tidak akan dimasukkan dengan peristiwa.

LocalTimestampFormat

Enum yang mewakili format properti tanda waktu lokal yang perlu diatur.

ProvisioningState

Status penyediaan sumber daya.

TimeZoneOffset

Objek yang mewakili informasi offset untuk format tanda waktu lokal yang ditentukan. Tidak boleh ditentukan untuk LocalTimestampFormat - Tertanam.

CloudError

Berisi informasi tentang kesalahan API.

Name Type Description
error

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

Name Type Description
code
  • string

Kode kesalahan yang menjelaskan kondisi kesalahan lebih tepat daripada kode status HTTP. Dapat digunakan untuk menangani kasus kesalahan tertentu secara terprogram.

details

Berisi kesalahan berlapis yang terkait dengan kesalahan ini.

message
  • string

Pesan yang menjelaskan kesalahan secara rinci dan menyediakan informasi penelusuran kesalahan.

target
  • string

Target kesalahan tertentu (misalnya, nama properti dalam kesalahan).

EventHubEventSourceResource

Sumber kejadian yang menerima datanya dari Azure EventHub.

Name Type Description
creationTime
  • string

Waktu sumber daya dibuat.

eventSourceResourceId
  • string

Id sumber daya sumber kejadian di Azure Resource Manager.

id
  • string

ID sumber daya

ingressStartAt.time
  • string

Tanggalwaktu ISO8601 UTC dengan presisi detik (milidetik bersifat opsional), menentukan tanggal dan waktu yang akan menjadi titik awal peristiwa yang akan digunakan.

ingressStartAt.type

Jenis ingressStartAt, Dapat berupa "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

kind string:
  • Microsoft.EventHub

Jenis sumber peristiwa.

localTimestamp

Objek yang mewakili properti tanda waktu lokal. Ini berisi format tanda waktu lokal yang perlu digunakan dan informasi offset zona waktu yang sesuai. Jika nilai tidak ditentukan untuk localTimestamp, atau jika null, maka tanda waktu lokal tidak akan dimasukkan dengan peristiwa.

location
  • string

Lokasi sumber daya

name
  • string

Nama sumber daya

properties.consumerGroupName
  • string

Nama grup konsumen pusat aktivitas yang menyimpan partisi tempat peristiwa akan dibaca.

properties.eventHubName
  • string

Nama event hub.

properties.keyName
  • string

Nama kunci SAS yang memberi Time Series Insights akses layanan ke pusat aktivitas. Kebijakan akses bersama untuk kunci ini harus memberikan izin 'Dengar' ke hub peristiwa.

properties.serviceBusNamespace
  • string

Nama bus layanan yang berisi pusat aktivitas.

provisioningState

Status penyediaan sumber daya.

tags
  • object

Tag sumber daya

timestampPropertyName
  • string

Properti acara yang akan digunakan sebagai tanda waktu sumber kejadian. Jika nilai tidak ditentukan untuk timestampPropertyName, atau jika string null atau kosong ditentukan, waktu pembuatan peristiwa akan digunakan.

type
  • string

Jenis Sumber Daya

IngressStartAtType

Jenis ingressStartAt, Dapat berupa "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

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

IoTHubEventSourceResource

Sumber peristiwa yang menerima datanya dari Azure IoTHub.

Name Type Description
creationTime
  • string

Waktu sumber daya dibuat.

eventSourceResourceId
  • string

Id sumber daya sumber kejadian di Azure Resource Manager.

id
  • string

ID sumber daya

ingressStartAt.time
  • string

Tanggalwaktu ISO8601 UTC dengan presisi detik (milidetik bersifat opsional), menentukan tanggal dan waktu yang akan menjadi titik awal peristiwa yang akan digunakan.

ingressStartAt.type

Jenis ingressStartAt, Dapat berupa "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

kind string:
  • Microsoft.IoTHub

Jenis sumber peristiwa.

localTimestamp

Objek yang mewakili properti tanda waktu lokal. Ini berisi format tanda waktu lokal yang perlu digunakan dan informasi offset zona waktu yang sesuai. Jika nilai tidak ditentukan untuk localTimestamp, atau jika null, maka tanda waktu lokal tidak akan dimasukkan dengan peristiwa.

location
  • string

Lokasi sumber daya

name
  • string

Nama sumber daya

properties.consumerGroupName
  • string

Nama grup konsumen iot hub yang menyimpan partisi tempat peristiwa akan dibaca.

properties.iotHubName
  • string

Nama hub iot.

properties.keyName
  • string

Nama kunci Kebijakan Akses Bersama yang memberi Time Series Insights akses layanan ke hub iot. Kunci kebijakan akses bersama ini harus memberikan izin 'sambungan layanan' ke hub iot.

provisioningState

Status penyediaan sumber daya.

tags
  • object

Tag sumber daya

timestampPropertyName
  • string

Properti acara yang akan digunakan sebagai tanda waktu sumber kejadian. Jika nilai tidak ditentukan untuk timestampPropertyName, atau jika string null atau kosong ditentukan, waktu pembuatan peristiwa akan digunakan.

type
  • string

Jenis Sumber Daya

LocalTimestamp

Objek yang mewakili properti tanda waktu lokal. Ini berisi format tanda waktu lokal yang perlu digunakan dan informasi offset zona waktu yang sesuai. Jika nilai tidak ditentukan untuk localTimestamp, atau jika null, maka tanda waktu lokal tidak akan dimasukkan dengan peristiwa.

Name Type Description
format

Enum yang mewakili format properti tanda waktu lokal yang perlu diatur.

timeZoneOffset

Objek yang mewakili informasi offset untuk format tanda waktu lokal yang ditentukan. Tidak boleh ditentukan untuk LocalTimestampFormat - Tertanam.

LocalTimestampFormat

Enum yang mewakili format properti tanda waktu lokal yang perlu diatur.

Name Type Description
Embedded
  • string

ProvisioningState

Status penyediaan sumber daya.

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

TimeZoneOffset

Objek yang mewakili informasi offset untuk format tanda waktu lokal yang ditentukan. Tidak boleh ditentukan untuk LocalTimestampFormat - Tertanam.

Name Type Description
propertyName
  • string

Properti peristiwa yang akan berisi informasi offset untuk menghitung tanda waktu lokal. Ketika LocalTimestampFormat adalah Iana, nama properti akan berisi nama kolom yang berisi Nama Zona Waktu IANA (misalnya: Amerika/Los Angeles). Ketika LocalTimestampFormat adalah Timespan, itu berisi nama properti yang berisi nilai yang mewakili offset (misalnya: P1D atau 1.00:00:00)