Event Sources - Get

Odwołanie

Service:: Time Series Insights

API Version:: 2020-05-15

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

Nazwa	W	Wymagane	Typ	Opis
environmentName	path	True	string	Nazwa środowiska usługi Time Series Insights skojarzonego z określoną grupą zasobów.
eventSourceName	path	True	string	Nazwa źródła zdarzeń usługi Time Series Insights skojarzonego 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

Nazwa	Typ	Opis
200 OK	EventSourceResource: EventHubEventSourceResource IoTHubEventSourceResource	Definicja źródła zdarzeń została pomyślnie pobrana i znajduje się w odpowiedzi.
Other Status Codes	CloudError	HTTP 404 (Nie znaleziono): nie można odnaleźć subskrypcji, grupy zasobów, środowiska lub źródła zdarzeń.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
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

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

Definicje

Nazwa	Opis
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ść sygnatury czasowej. 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.

Nazwa	Typ	Opis
error	CloudErrorBody	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.

Nazwa	Typ	Opis
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	CloudErrorBody[]	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.

Nazwa	Typ	Opis
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 data/godzina UTC 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	IngressStartAtType	Typ ruchu przychodzącegoStartAt, może to być "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
kind	string: Microsoft.EventHub	Rodzaj źródła zdarzeń.
localTimestamp	LocalTimestamp	Obiekt reprezentujący lokalną właściwość sygnatury czasowej. 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 udziela usłudze Time Series Insights dostępu 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	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".

Nazwa	Typ	Opis
CustomEnqueuedTime	string
EarliestAvailable	string
EventSourceCreationTime	string

IoTHubEventSourceResource

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

Nazwa	Typ	Opis
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 data/godzina UTC 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	IngressStartAtType	Typ ruchu przychodzącegoStartAt, może to być "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
kind	string: Microsoft.IoTHub	Rodzaj źródła zdarzeń.
localTimestamp	LocalTimestamp	Obiekt reprezentujący lokalną właściwość sygnatury czasowej. 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 udziela usłudze Time Series Insights dostępu do centrum iot. Ten klucz zasad dostępu współdzielonego musi udzielić uprawnień "service connect" do centrum iot.
provisioningState	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ść sygnatury czasowej. 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.

Nazwa	Typ	Opis
format	LocalTimestampFormat	Wyliczenie reprezentujące format właściwości sygnatury czasowej lokalnej, która musi zostać ustawiona.
timeZoneOffset	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.

Nazwa	Typ	Opis
Embedded	string

ProvisioningState

Stan aprowizacji zasobu.

Nazwa	Typ	Opis
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.

Nazwa	Typ	Opis
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)