Event Sources - Get

Referenz

Service:: Time Series Insights

API Version:: 2020-05-15

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	Erforderlich	Typ	Beschreibung
environmentName	path	True	string	Der Name der Time Series Insights-Umgebung, die der angegebenen Ressourcengruppe zugeordnet ist.
eventSourceName	path	True	string	Der Name der Time Series 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	Typ	Beschreibung
200 OK	EventSourceResource: EventHubEventSourceResource IoTHubEventSourceResource	Die Ereignisquellendefinition wurde erfolgreich abgerufen und befindet sich in der Antwort.
Other Status Codes	CloudError	HTTP 404 (Nicht gefunden): Das Abonnement, die Ressourcengruppe, die Umgebung oder die Ereignisquelle wurde nicht gefunden.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
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

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

Definitionen

Name	Beschreibung
CloudError	Enthält Informationen zu einem API-Fehler.
CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
EventHubEventSourceResource	Eine Ereignisquelle, die ihre Daten von einem Azure EventHub empfängt.
IngressStartAtType	Der Typ des ingressStartAt, Es kann "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime" sein.
IoTHubEventSourceResource	Eine Ereignisquelle, die ihre Daten von einem Azure IoTHub empfängt.
LocalTimestamp	Ein -Objekt, das die lokale Zeitstempeleigenschaft darstellt. Es enthält das Format des lokalen Zeitstempels, der verwendet werden muss, und die entsprechenden Zeitzonenoffsetinformationen. Wenn für localTimestamp kein Wert angegeben ist oder null ist, wird der lokale Zeitstempel nicht mit den Ereignissen in den Eingang übertragen.
LocalTimestampFormat	Eine Enumeration, die das Format der lokalen Zeitstempeleigenschaft darstellt, die festgelegt werden muss.
ProvisioningState	Bereitstellungsstatus der Ressource.
TimeZoneOffset	Ein -Objekt, das die Offsetinformationen für das angegebene lokale Zeitstempelformat darstellt. Sollte für LocalTimestampFormat – Embedded nicht angegeben werden.

CloudError

Enthält Informationen zu einem API-Fehler.

Name	Typ	Beschreibung
error	CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

CloudErrorBody

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

Name	Typ	Beschreibung
code	string	Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-status Code. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details	CloudErrorBody[]	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 von einem Azure EventHub empfängt.

Name	Typ	Beschreibung
creationTime	string	Der Zeitpunkt, zu dem die Ressource erstellt wurde.
eventSourceResourceId	string	Die Ressourcen-ID der Ereignisquelle in Azure Resource Manager.
id	string	Ressourcen-ID
ingressStartAt.time	string	ISO8601 UTC datetime mit Sekundengenauigkeit (Millisekunden sind optional) und geben das Datum und die Uhrzeit an, die der Ausgangspunkt für die Zu verwendenden Ereignisse sein werden.
ingressStartAt.type	IngressStartAtType	Der Typ des ingressStartAt, Es kann "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime" sein.
kind	string: Microsoft.EventHub	Die Art der Ereignisquelle.
localTimestamp	LocalTimestamp	Ein -Objekt, das die lokale Zeitstempeleigenschaft darstellt. Es enthält das Format des lokalen Zeitstempels, der verwendet werden muss, und die entsprechenden Zeitzonenoffsetinformationen. Wenn für localTimestamp kein Wert angegeben ist oder null ist, wird der lokale Zeitstempel nicht mit den Ereignissen in den Eingang übertragen.
location	string	Ressourcenspeicherort
name	string	Ressourcenname
properties.consumerGroupName	string	Der Name der Consumergruppe des Event Hubs, 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 dem Time Series Insights-Dienst Zugriff auf den Event Hub gewährt. Die SAS-Richtlinien für diesen Schlüssel müssen dem Event Hub die Berechtigung "Listen" erteilen.
properties.serviceBusNamespace	string	Der Name des Service Bus, der den Event Hub enthält.
provisioningState	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, Es kann "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime" sein.

Name	Typ	Beschreibung
CustomEnqueuedTime	string
EarliestAvailable	string
EventSourceCreationTime	string

IoTHubEventSourceResource

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

Name	Typ	Beschreibung
creationTime	string	Der Zeitpunkt, zu dem die Ressource erstellt wurde.
eventSourceResourceId	string	Die Ressourcen-ID der Ereignisquelle in Azure Resource Manager.
id	string	Ressourcen-ID
ingressStartAt.time	string	ISO8601 UTC datetime mit Sekundengenauigkeit (Millisekunden sind optional) und geben das Datum und die Uhrzeit an, die der Ausgangspunkt für die Zu verwendenden Ereignisse sein werden.
ingressStartAt.type	IngressStartAtType	Der Typ des ingressStartAt, Es kann "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime" sein.
kind	string: Microsoft.IoTHub	Die Art der Ereignisquelle.
localTimestamp	LocalTimestamp	Ein -Objekt, das die lokale Zeitstempeleigenschaft darstellt. Es enthält das Format des lokalen Zeitstempels, der verwendet werden muss, und die entsprechenden Zeitzonenoffsetinformationen. Wenn für localTimestamp kein Wert angegeben ist oder null ist, wird der lokale Zeitstempel nicht mit den Ereignissen in den Eingang übertragen.
location	string	Ressourcenspeicherort
name	string	Ressourcenname
properties.consumerGroupName	string	Der Name der Consumergruppe 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 Shared Access-Richtlinienschlüssels, der dem Time Series Insights-Dienst Zugriff auf den iot Hub gewährt. Dieser Sas-Richtlinienschlüssel muss dem iot Hub die Berechtigung "Dienstverbindung" erteilen.
provisioningState	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 Zeitstempeleigenschaft darstellt. Es enthält das Format des lokalen Zeitstempels, der verwendet werden muss, und die entsprechenden Zeitzonenoffsetinformationen. Wenn für localTimestamp kein Wert angegeben ist oder null ist, wird der lokale Zeitstempel nicht mit den Ereignissen in den Eingang übertragen.

Name	Typ	Beschreibung
format	LocalTimestampFormat	Eine Enumeration, die das Format der lokalen Zeitstempeleigenschaft darstellt, die festgelegt werden muss.
timeZoneOffset	TimeZoneOffset	Ein -Objekt, das die Offsetinformationen für das angegebene lokale Zeitstempelformat darstellt. Sollte für LocalTimestampFormat – Embedded nicht angegeben werden.

LocalTimestampFormat

Eine Enumeration, die das Format der lokalen Zeitstempeleigenschaft darstellt, die festgelegt werden muss.

Name	Typ	Beschreibung
Embedded	string

ProvisioningState

Bereitstellungsstatus der Ressource.

Name	Typ	Beschreibung
Accepted	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

TimeZoneOffset

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

Name	Typ	Beschreibung
propertyName	string	Die Ereigniseigenschaft, die die Offsetinformationen zum Berechnen des lokalen Zeitstempels enthält. Wenn LocalTimestampFormat auf Iana festgelegt ist, enthält der Name der Eigenschaft den Namen der Spalte, die den IANA-Zeitzonennamen (z. B. Americas/Los Angeles) enthält. Wenn LocalTimestampFormat auf Timespan festgelegt ist, enthält es den Namen der Eigenschaft, die Werte enthält, die den Offset darstellen (z. B. P1D oder 1.00:00:00).