Event Sources - Get

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

Name In Required Type Description
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

Name Type Description
200 OK EventSourceResource:

La definizione dell'origine evento è stata recuperata correttamente e si trova nella risposta.

Other Status Codes

HTTP 404 (Not Found): impossibile trovare la sottoscrizione, il gruppo di risorse, l'ambiente o l'origine eventi.

Sicurezza

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

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

Definizioni

CloudError

Contiene informazioni su un errore dell'API.

CloudErrorBody

Descrive un errore dell'API specifico 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 un Azure IoTHub.

LocalTimestamp

Oggetto che rappresenta la proprietà timestamp locale. Contiene il formato del timestamp locale che deve essere usato e le informazioni relative all'offset del fuso orario corrispondente. Se un valore non è specificato per localTimestamp o se 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 di offset per il formato timestamp locale specificato. Non deve essere specificato per LocalTimestampFormat - Embedded.

CloudError

Contiene informazioni su un errore dell'API.

Name Type Description
error

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

CloudErrorBody

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

Name Type Description
code
  • string

Codice di errore che descrive la condizione di errore più precisamente di un codice di stato HTTP. Può essere usato per gestire casi di errore specifici a livello di codice.

details

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.

Name Type Description
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 secondi (millisecondi sono facoltativi), specificando la data e l'ora che sarà il punto di partenza per l'utilizzo degli eventi.

ingressStartAt.type

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

kind string:
  • Microsoft.EventHub

Tipo di origine evento.

localTimestamp

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

location
  • string

Posizione risorsa

name
  • string

Nome risorsa

properties.consumerGroupName
  • string

Nome del gruppo 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 l'accesso al servizio Time Series Insights all'hub eventi. I criteri di accesso condiviso per questa chiave devono concedere le autorizzazioni "Listen" all'hub eventi.

properties.serviceBusNamespace
  • string

Nome del bus di servizio che contiene l'hub eventi.

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

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

IoTHubEventSourceResource

Origine evento che riceve i dati da un Azure IoTHub.

Name Type Description
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 secondi (millisecondi sono facoltativi), specificando la data e l'ora che sarà il punto di partenza per l'utilizzo degli eventi.

ingressStartAt.type

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

kind string:
  • Microsoft.IoTHub

Tipo di origine evento.

localTimestamp

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

location
  • string

Posizione risorsa

name
  • string

Nome risorsa

properties.consumerGroupName
  • string

Nome del gruppo 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 criteri di accesso condiviso che concede all'hub iot l'accesso al servizio Time Series Insights. Questa chiave dei criteri di accesso condiviso deve concedere le autorizzazioni "service connect" all'hub iot.

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 relative all'offset del fuso orario corrispondente. Se un valore non è specificato per localTimestamp o se null, il timestamp locale non verrà inserito con gli eventi.

Name Type Description
format

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

timeZoneOffset

Oggetto che rappresenta le informazioni di 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.

Name Type Description
Embedded
  • string

ProvisioningState

Stato di provisioning della risorsa.

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

TimeZoneOffset

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

Name Type Description
propertyName
  • string

Proprietà evento che conterrà le informazioni di offset per calcolare il timestamp locale. Quando LocalTimestampFormat è Iana, il nome della proprietà conterrà il nome della colonna contenente 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)