Event Sources - Get

Riferimento

Service:: Time Series Insights

API Version:: 2020-05-15

Ottiene l'origine evento con il nome specificato nell'ambiente specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
environmentName	path	True	string	Nome dell'ambiente Time Series Insights associato al gruppo di risorse specificato.
eventSourceName	path	True	string	Nome dell'origine evento Time Series Insights associata all'ambiente specificato.
resourceGroupName	path	True	string	Nome di un gruppo di risorse di Azure.
subscriptionId	path	True	string	ID sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare con la richiesta client.

Risposte

Nome	Tipo	Descrizione
200 OK	EventSourceResource: EventHubEventSourceResource IoTHubEventSourceResource	La definizione dell'origine evento è stata recuperata correttamente e si trova nella risposta.
Other Status Codes	CloudError	HTTP 404 (Non trovato): impossibile trovare la sottoscrizione, il gruppo di risorse, l'ambiente o l'origine evento.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
CloudError	Contiene informazioni su un errore dell'API.
CloudErrorBody	Descrive un particolare errore dell'API con un codice di errore e un messaggio.
EventHubEventSourceResource	Origine evento che riceve i dati da un hub eventi di Azure.
IngressStartAtType	Il tipo di ingressStartAt, può essere "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
IoTHubEventSourceResource	Origine evento che riceve i dati da azure IoTHub.
LocalTimestamp	Oggetto che rappresenta la proprietà timestamp locale. Contiene il formato del timestamp locale che deve essere usato e le informazioni corrispondenti sull'offset del fuso orario. Se non viene specificato un valore per localTimestamp o null, il timestamp locale non verrà inserito con gli eventi.
LocalTimestampFormat	Enumerazione che rappresenta il formato della proprietà timestamp locale che deve essere impostata.
ProvisioningState	Stato di provisioning della risorsa.
TimeZoneOffset	Oggetto che rappresenta le informazioni sull'offset per il formato timestamp locale specificato. Non deve essere specificato per LocalTimestampFormat - Embedded.

CloudError

Contiene informazioni su un errore dell'API.

Nome	Tipo	Descrizione
error	CloudErrorBody	Descrive un particolare errore dell'API con un codice di errore e un messaggio.

CloudErrorBody

Descrive un particolare errore dell'API con un codice di errore e un messaggio.

Nome	Tipo	Descrizione
code	string	Codice di errore che descrive più precisamente la condizione di errore rispetto a un codice di stato HTTP. Può essere usato per gestire casi di errore specifici a livello di codice.
details	CloudErrorBody[]	Contiene errori annidati correlati a questo errore.
message	string	Messaggio che descrive l'errore in dettaglio e fornisce informazioni di debug.
target	string	Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore.

EventHubEventSourceResource

Origine evento che riceve i dati da un hub eventi di Azure.

Nome	Tipo	Descrizione
creationTime	string	Ora di creazione della risorsa.
eventSourceResourceId	string	ID risorsa dell'origine evento in Azure Resource Manager.
id	string	ID risorsa
ingressStartAt.time	string	ISO8601 utc datetime con precisione dei secondi (millisecondi sono facoltativi), specificando la data e l'ora che sarà il punto di partenza per l'utilizzo degli eventi.
ingressStartAt.type	IngressStartAtType	Il tipo di ingressStartAt, può essere "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
kind	string: Microsoft.EventHub	Tipo dell'origine evento.
localTimestamp	LocalTimestamp	Oggetto che rappresenta la proprietà timestamp locale. Contiene il formato del timestamp locale che deve essere usato e le informazioni corrispondenti sull'offset del fuso orario. Se non viene specificato un valore per localTimestamp o null, il timestamp locale non verrà inserito con gli eventi.
location	string	Posizione risorsa
name	string	Nome risorsa
properties.consumerGroupName	string	Nome del gruppo di consumer dell'hub eventi che contiene le partizioni da cui verranno letti gli eventi.
properties.eventHubName	string	Nome di Hub eventi.
properties.keyName	string	Nome della chiave di firma di accesso condiviso che concede al servizio Time Series Insights l'accesso all'hub eventi. I criteri di accesso condiviso per questa chiave devono concedere le autorizzazioni di ascolto all'hub eventi.
properties.serviceBusNamespace	string	Nome del bus di servizio che contiene l'hub eventi.
provisioningState	ProvisioningState	Stato di provisioning della risorsa.
tags	object	Tag delle risorse
timestampPropertyName	string	La proprietà di evento che verrà usata come timestamp dell'origine evento. Se non è specificato un valore per timestampPropertyName o se viene specificato null o una stringa vuota, verrà usata l'ora di creazione dell'evento.
type	string	Tipo di risorsa

IngressStartAtType

Il tipo di ingressStartAt, può essere "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

Nome	Tipo	Descrizione
CustomEnqueuedTime	string
EarliestAvailable	string
EventSourceCreationTime	string

IoTHubEventSourceResource

Origine evento che riceve i dati da azure IoTHub.

Nome	Tipo	Descrizione
creationTime	string	Ora di creazione della risorsa.
eventSourceResourceId	string	ID risorsa dell'origine evento in Azure Resource Manager.
id	string	ID risorsa
ingressStartAt.time	string	ISO8601 utc datetime con precisione dei secondi (millisecondi sono facoltativi), specificando la data e l'ora che sarà il punto di partenza per l'utilizzo degli eventi.
ingressStartAt.type	IngressStartAtType	Il tipo di ingressStartAt, può essere "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
kind	string: Microsoft.IoTHub	Tipo dell'origine evento.
localTimestamp	LocalTimestamp	Oggetto che rappresenta la proprietà timestamp locale. Contiene il formato del timestamp locale che deve essere usato e le informazioni corrispondenti sull'offset del fuso orario. Se non viene specificato un valore per localTimestamp o null, il timestamp locale non verrà inserito con gli eventi.
location	string	Posizione risorsa
name	string	Nome risorsa
properties.consumerGroupName	string	Nome del gruppo di consumer dell'hub iot che contiene le partizioni da cui verranno letti gli eventi.
properties.iotHubName	string	Nome dell'hub iot.
properties.keyName	string	Nome della chiave dei criteri di accesso condiviso che concede al servizio Time Series Insights l'accesso all'hub iot. Questa chiave dei criteri di accesso condiviso deve concedere le autorizzazioni di connessione del servizio all'hub iot.
provisioningState	ProvisioningState	Stato di provisioning della risorsa.
tags	object	Tag delle risorse
timestampPropertyName	string	La proprietà di evento che verrà usata come timestamp dell'origine evento. Se non è specificato un valore per timestampPropertyName o se viene specificato null o una stringa vuota, verrà usata l'ora di creazione dell'evento.
type	string	Tipo di risorsa

LocalTimestamp

Oggetto che rappresenta la proprietà timestamp locale. Contiene il formato del timestamp locale che deve essere usato e le informazioni corrispondenti sull'offset del fuso orario. Se non viene specificato un valore per localTimestamp o null, il timestamp locale non verrà inserito con gli eventi.

Nome	Tipo	Descrizione
format	LocalTimestampFormat	Enumerazione che rappresenta il formato della proprietà timestamp locale che deve essere impostata.
timeZoneOffset	TimeZoneOffset	Oggetto che rappresenta le informazioni sull'offset per il formato timestamp locale specificato. Non deve essere specificato per LocalTimestampFormat - Embedded.

LocalTimestampFormat

Enumerazione che rappresenta il formato della proprietà timestamp locale che deve essere impostata.

Nome	Tipo	Descrizione
Embedded	string

ProvisioningState

Stato di provisioning della risorsa.

Nome	Tipo	Descrizione
Accepted	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

TimeZoneOffset

Oggetto che rappresenta le informazioni sull'offset per il formato timestamp locale specificato. Non deve essere specificato per LocalTimestampFormat - Embedded.

Nome	Tipo	Descrizione
propertyName	string	Proprietà dell'evento che conterrà le informazioni sull'offset per calcolare il timestamp locale. Quando LocalTimestampFormat è Iana, il nome della proprietà conterrà il nome della colonna che contiene il nome del fuso orario IANA, ad esempio Americas/Los Angeles. Quando LocalTimestampFormat è Timespan, contiene il nome della proprietà che contiene valori che rappresentano l'offset , ad esempio P1D o 1.00:00:00.00