Event Sources - Get

Referensi

Service:: Time Series Insights

API Version:: 2020-05-15

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

Nama	Dalam	Diperlukan	Jenis	Deskripsi
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

Nama	Jenis	Deskripsi
200 OK	EventSourceResource: EventHubEventSourceResource IoTHubEventSourceResource	Definisi sumber kejadian berhasil diambil dan berada dalam respons.
Other Status Codes	CloudError	HTTP 404 (Tidak Ditemukan): Langganan, grup sumber daya, lingkungan, atau sumber peristiwa tidak dapat ditemukan.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
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

/** Samples for EventSources Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesGetEventHub.json
     */
    /**
     * Sample code: GetEventHubEventSource.
     *
     * @param manager Entry point to TimeSeriesInsightsManager.
     */
    public static void getEventHubEventSource(
        com.azure.resourcemanager.timeseriesinsights.TimeSeriesInsightsManager manager) {
        manager.eventSources().getWithResponse("rg1", "env1", "es1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armtimeseriesinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesGetEventHub.json
func ExampleEventSourcesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armtimeseriesinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEventSourcesClient().Get(ctx, "rg1", "env1", "es1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armtimeseriesinsights.EventSourcesClientGetResponse{
	// 	                            EventSourceResourceClassification: &armtimeseriesinsights.EventHubEventSourceResource{
	// 		Name: to.Ptr("es1"),
	// 		Type: to.Ptr("Microsoft.TimeSeriesInsights/Environments/EventSources"),
	// 		ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1"),
	// 		Location: to.Ptr("West US"),
	// 		Tags: map[string]*string{
	// 		},
	// 		Kind: to.Ptr(armtimeseriesinsights.EventSourceResourceKindMicrosoftEventHub),
	// 		Properties: &armtimeseriesinsights.EventHubEventSourceResourceProperties{
	// 			CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-04-18T19:20:33.228Z"); return t}()),
	// 			ProvisioningState: to.Ptr(armtimeseriesinsights.ProvisioningStateSucceeded),
	// 			IngressStartAt: &armtimeseriesinsights.IngressStartAtProperties{
	// 				Type: to.Ptr(armtimeseriesinsights.IngressStartAtTypeEarliestAvailable),
	// 			},
	// 			LocalTimestamp: &armtimeseriesinsights.LocalTimestamp{
	// 				Format: to.Ptr(armtimeseriesinsights.LocalTimestampFormat("TimeSpan")),
	// 				TimeZoneOffset: &armtimeseriesinsights.LocalTimestampTimeZoneOffset{
	// 					PropertyName: to.Ptr("someEventPropertyName"),
	// 				},
	// 			},
	// 			EventSourceResourceID: to.Ptr("somePathInArm"),
	// 			ConsumerGroupName: to.Ptr("cgn"),
	// 			EventHubName: to.Ptr("ehn"),
	// 			KeyName: to.Ptr("managementKey"),
	// 			ServiceBusNamespace: to.Ptr("sbn"),
	// 		},
	// 	},
	// 	                        }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

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

Nama	Deskripsi
CloudError	Berisi informasi tentang kesalahan API.
CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
EventHubEventSourceResource	Sumber peristiwa 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 - Embedded.

CloudError

Berisi informasi tentang kesalahan API.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

CloudErrorBody

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan yang menjelaskan kondisi kesalahan lebih tepat daripada kode status HTTP. Dapat digunakan untuk menangani kasus kesalahan tertentu secara terprogram.
details	CloudErrorBody[]	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 peristiwa yang menerima datanya dari Azure EventHub.

Nama	Jenis	Deskripsi
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	ISO8601 tanggalwaktu UTC dengan presisi detik (milidetik bersifat opsional), menentukan tanggal dan waktu yang akan menjadi titik awal peristiwa yang akan dikonsumsi.
ingressStartAt.type	IngressStartAtType	Jenis ingressStartAt, Dapat berupa "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
kind	string: Microsoft.EventHub	Jenis sumber peristiwa.
localTimestamp	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 memberikan akses layanan Time Series Insights ke pusat aktivitas. Kebijakan akses bersama untuk kunci ini harus memberikan izin 'Dengarkan' ke hub peristiwa.
properties.serviceBusNamespace	string	Nama bus layanan yang berisi pusat aktivitas.
provisioningState	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".

Nama	Jenis	Deskripsi
CustomEnqueuedTime	string
EarliestAvailable	string
EventSourceCreationTime	string

IoTHubEventSourceResource

Sumber peristiwa yang menerima datanya dari Azure IoTHub.

Nama	Jenis	Deskripsi
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	ISO8601 tanggalwaktu UTC dengan presisi detik (milidetik bersifat opsional), menentukan tanggal dan waktu yang akan menjadi titik awal peristiwa yang akan dikonsumsi.
ingressStartAt.type	IngressStartAtType	Jenis ingressStartAt, Dapat berupa "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
kind	string: Microsoft.IoTHub	Jenis sumber peristiwa.
localTimestamp	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 memberikan akses layanan Time Series Insights ke hub iot. Kunci kebijakan akses bersama ini harus memberikan izin 'koneksi layanan' ke hub iot.
provisioningState	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.

Nama	Jenis	Deskripsi
format	LocalTimestampFormat	Enum yang mewakili format properti tanda waktu lokal yang perlu diatur.
timeZoneOffset	TimeZoneOffset	Objek yang mewakili informasi offset untuk format tanda waktu lokal yang ditentukan. Tidak boleh ditentukan untuk LocalTimestampFormat - Embedded.

LocalTimestampFormat

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

Nama	Jenis	Deskripsi
Embedded	string

ProvisioningState

Status penyediaan sumber daya.

Nama	Jenis	Deskripsi
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 - Embedded.

Nama	Jenis	Deskripsi
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: Americas/Los Angeles). Ketika LocalTimestampFormat adalah Timespan, itu berisi nama properti yang berisi nilai yang mewakili offset (misalnya: P1D atau 1.00:00:00)