Sdílet prostřednictvím


Event Sources - Create Or Update

Vytvořte nebo aktualizujte zdroj událostí v zadaném prostředí.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
environmentName
path True

string

Název prostředí Time Series Insights přidruženého k zadané skupině prostředků.

eventSourceName
path True

string

Název zdroje události.

Regex pattern: ^[-\w\._\(\)]+$

resourceGroupName
path True

string

Název skupiny prostředků Azure.

subscriptionId
path True

string

ID předplatného Azure.

api-version
query True

string

Verze rozhraní API, která se má použít s požadavkem klienta.

Text požadavku

Text žádosti může tvořit:

Name Description
EventHubEventSourceCreateOrUpdateParameters

Parametry zadané pro operaci Vytvoření nebo aktualizace zdroje událostí pro zdroj událostí EventHub.

IoTHubEventSourceCreateOrUpdateParameters

Parametry zadané pro operaci Vytvoření nebo aktualizace zdroje událostí pro zdroj událostí IoTHub.

EventHubEventSourceCreateOrUpdateParameters

Parametry zadané pro operaci Vytvoření nebo aktualizace zdroje událostí pro zdroj událostí EventHub.

Name Vyžadováno Typ Description
eventSourceResourceId True

string

ID prostředku zdroje události v Azure Resource Manager.

kind True string:

Microsoft.EventHub

Druh zdroje událostí.

location True

string

Umístění prostředku.

properties.consumerGroupName True

string

Název skupiny příjemců centra událostí, která obsahuje oddíly, ze kterých se budou události číst.

properties.eventHubName True

string

Název centra událostí.

properties.keyName True

string

Název klíče SAS, který uděluje službě Time Series Insights přístup k centru událostí. Zásady sdíleného přístupu pro tento klíč musí centru událostí udělit oprávnění Naslouchat.

properties.serviceBusNamespace True

string

Název služby Service Bus, která obsahuje centrum událostí.

properties.sharedAccessKey True

string

Hodnota sdíleného přístupového klíče, který uděluje službě Time Series Insights přístup ke čtení k centru událostí. Tato vlastnost se nezobrazuje v odpovědích na zdroj událostí.

ingressStartAt.time

string

ISO8601 datum a čas UTC s přesností na sekundy (milisekundy jsou volitelné) a zadejte datum a čas, které budou výchozím bodem pro příjem událostí.

ingressStartAt.type

IngressStartAtType

Typ ingressStartAt, může to být "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

localTimestamp

LocalTimestamp

Objekt, který představuje místní vlastnost časového razítka. Obsahuje formát místního časového razítka, které je potřeba použít, a odpovídající informace o posunu časového pásma. Pokud hodnota není zadaná pro localTimestamp nebo pokud null, místní časové razítko nebude ingressováno s událostmi.

tags

object

Páry klíč-hodnota dalších vlastností prostředku.

timestampPropertyName

string

Vlastnost události, která se použije jako časové razítko zdroje události. Pokud není pro timestampPropertyName zadána hodnota nebo pokud je zadána hodnota null nebo prázdný řetězec, použije se čas vytvoření události.

IoTHubEventSourceCreateOrUpdateParameters

Parametry zadané pro operaci Vytvoření nebo aktualizace zdroje událostí pro zdroj událostí IoTHub.

Name Vyžadováno Typ Description
eventSourceResourceId True

string

ID prostředku zdroje události v Azure Resource Manager.

kind True string:

Microsoft.IoTHub

Druh zdroje událostí.

location True

string

Umístění prostředku.

properties.consumerGroupName True

string

Název skupiny uživatelů ioT Hubu, která obsahuje oddíly, ze kterých se budou číst události.

properties.iotHubName True

string

Název ioT Hubu.

properties.keyName True

string

Název klíče zásad sdíleného přístupu, který uděluje službě Time Series Insights přístup k ioT Hubu. Tento klíč zásad sdíleného přístupu musí službě ioT Hub udělit oprávnění service connect.

properties.sharedAccessKey True

string

Hodnota klíče zásad sdíleného přístupu, který uděluje službě Time Series Insights přístup ke čtení ke službě ioT Hub. Tato vlastnost se nezobrazuje v odpovědích na zdroj událostí.

ingressStartAt.time

string

ISO8601 datum a čas UTC s přesností na sekundy (milisekundy jsou volitelné) a zadejte datum a čas, které budou výchozím bodem pro příjem událostí.

ingressStartAt.type

IngressStartAtType

Typ ingressStartAt, může to být "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

localTimestamp

LocalTimestamp

Objekt, který představuje místní vlastnost časového razítka. Obsahuje formát místního časového razítka, které je potřeba použít, a odpovídající informace o posunu časového pásma. Pokud hodnota není zadaná pro localTimestamp nebo pokud null, místní časové razítko nebude ingressováno s událostmi.

tags

object

Páry klíč-hodnota dalších vlastností prostředku.

timestampPropertyName

string

Vlastnost události, která se použije jako časové razítko zdroje události. Pokud není pro timestampPropertyName zadána hodnota nebo pokud je zadána hodnota null nebo prázdný řetězec, použije se čas vytvoření události.

Odpovědi

Name Typ Description
200 OK EventSourceResource:

Existující definice zdroje událostí byla úspěšně aktualizována.

201 Created EventSourceResource:

Zdroj události byl úspěšně vytvořen.

Other Status Codes

CloudError

HTTP 400 (Chybný požadavek): Daný text požadavku zdroje události je neplatný; Podrobnosti najdete v kódu chyby a zprávě v odpovědi.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

CreateEventHubEventSource
EventSourcesCreateEventHubWithCustomEnquedTime

CreateEventHubEventSource

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/environments/env1/eventSources/es1?api-version=2020-05-15

{
  "location": "West US",
  "kind": "Microsoft.EventHub",
  "properties": {
    "eventSourceResourceId": "somePathInArm",
    "serviceBusNamespace": "sbn",
    "consumerGroupName": "cgn",
    "eventHubName": "ehn",
    "keyName": "managementKey",
    "sharedAccessKey": "someSecretvalue",
    "timestampPropertyName": "someTimestampProperty",
    "localTimestamp": {
      "format": "TimeSpan",
      "timeZoneOffset": {
        "propertyName": "someEventPropertyName"
      }
    },
    "ingressStartAt": {
      "type": "EarliestAvailable"
    }
  }
}

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

EventSourcesCreateEventHubWithCustomEnquedTime

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/environments/env1/eventSources/es1?api-version=2020-05-15

{
  "location": "West US",
  "kind": "Microsoft.EventHub",
  "properties": {
    "eventSourceResourceId": "somePathInArm",
    "serviceBusNamespace": "sbn",
    "consumerGroupName": "cgn",
    "eventHubName": "ehn",
    "keyName": "managementKey",
    "sharedAccessKey": "someSecretvalue",
    "timestampPropertyName": "someTimestampProperty",
    "ingressStartAt": {
      "type": "CustomEnqueuedTime",
      "time": "2017-04-01T19:20:33.2288820Z"
    }
  }
}

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",
    "ingressStartAt": {
      "type": "CustomEnqueuedTime",
      "time": "2017-04-01T19:20:33.2288820Z"
    }
  }
}
{
  "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",
    "ingressStartAt": {
      "type": "CustomEnqueuedTime",
      "time": "2017-04-01T19:20:33.2288820Z"
    }
  }
}

Definice

Name Description
CloudError

Obsahuje informace o chybě rozhraní API.

CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

EventHubEventSourceCreateOrUpdateParameters

Parametry zadané pro operaci Vytvoření nebo aktualizace zdroje událostí pro zdroj událostí EventHub.

EventHubEventSourceResource

Zdroj události, který přijímá data z Azure EventHubu.

IngressStartAtType

Typ ingressStartAt, Může to být "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

IoTHubEventSourceCreateOrUpdateParameters

Parametry zadané pro operaci Vytvoření nebo aktualizace zdroje událostí pro zdroj událostí IoTHubu

IoTHubEventSourceResource

Zdroj událostí, který přijímá data z Azure IoTHubu.

LocalTimestamp

Objekt, který představuje místní vlastnost časového razítka. Obsahuje formát místního časového razítka, které je potřeba použít, a odpovídající informace o posunu časového pásma. Pokud hodnota není zadána pro localTimestamp nebo null, místní časové razítko nebude příchozím přenosem dat s událostmi.

LocalTimestampFormat

Výčt, který představuje formát vlastnosti místního časového razítka, kterou je třeba nastavit.

ProvisioningState

Stav zřizování prostředku.

TimeZoneOffset

Objekt, který představuje informace o posunu pro zadaný místní formát časového razítka. Neměl by být zadán pro LocalTimestampFormat – Embedded.

CloudError

Obsahuje informace o chybě rozhraní API.

Name Typ Description
error

CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Name Typ Description
code

string

Kód chyby, který popisuje chybovou podmínku přesněji než stavový kód HTTP. Dá se použít ke zpracování konkrétních případů chyb prostřednictvím kódu programu.

details

CloudErrorBody[]

Obsahuje vnořené chyby, které s touto chybou souvisejí.

message

string

Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.

target

string

Cíl konkrétní chyby (například název vlastnosti v chybě).

EventHubEventSourceCreateOrUpdateParameters

Parametry zadané pro operaci Vytvoření nebo aktualizace zdroje událostí pro zdroj událostí EventHub.

Name Typ Description
creationTime

string

Čas vytvoření prostředku.

eventSourceResourceId

string

ID prostředku zdroje události v Azure Resource Manager.

ingressStartAt.time

string

ISO8601 datum a čas UTC s přesností sekund (milisekundy jsou volitelné) a určete datum a čas, které budou výchozím bodem pro využití událostí.

ingressStartAt.type

IngressStartAtType

Typ ingressStartAt, Může to být "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

kind string:

Microsoft.EventHub

Druh zdroje událostí.

localTimestamp

LocalTimestamp

Objekt, který představuje místní vlastnost časového razítka. Obsahuje formát místního časového razítka, které je potřeba použít, a odpovídající informace o posunu časového pásma. Pokud hodnota není zadána pro localTimestamp nebo null, místní časové razítko nebude příchozím přenosem dat s událostmi.

location

string

Umístění prostředku.

properties.consumerGroupName

string

Název skupiny příjemců centra událostí, která obsahuje oddíly, ze kterých se události budou číst.

properties.eventHubName

string

Název centra událostí.

properties.keyName

string

Název klíče SAS, který uděluje službě Time Series Insights přístup k centru událostí. Zásady sdíleného přístupu pro tento klíč musí centru událostí udělit oprávnění Naslouchat.

properties.serviceBusNamespace

string

Název služby Service Bus, která obsahuje centrum událostí.

properties.sharedAccessKey

string

Hodnota sdíleného přístupového klíče, který uděluje službě Time Series Insights přístup ke čtení k centru událostí. Tato vlastnost se nezobrazuje v odpovědích zdroje událostí.

provisioningState

ProvisioningState

Stav zřizování prostředku.

tags

object

Páry klíč-hodnota dalších vlastností prostředku.

timestampPropertyName

string

Vlastnost události, která se použije jako časové razítko zdroje událostí. Pokud není pro timestampPropertyName zadána hodnota nebo pokud je zadána hodnota null nebo prázdný řetězec, použije se čas vytvoření události.

EventHubEventSourceResource

Zdroj události, který přijímá data z Azure EventHubu.

Name Typ Description
creationTime

string

Čas vytvoření prostředku.

eventSourceResourceId

string

ID prostředku zdroje události v Azure Resource Manager.

id

string

ID prostředku

ingressStartAt.time

string

ISO8601 datum a čas UTC s přesností sekund (milisekundy jsou volitelné) a určete datum a čas, které budou výchozím bodem pro využití událostí.

ingressStartAt.type

IngressStartAtType

Typ ingressStartAt, Může to být "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

kind string:

Microsoft.EventHub

Druh zdroje událostí.

localTimestamp

LocalTimestamp

Objekt, který představuje místní vlastnost časového razítka. Obsahuje formát místního časového razítka, které je potřeba použít, a odpovídající informace o posunu časového pásma. Pokud hodnota není zadána pro localTimestamp nebo null, místní časové razítko nebude příchozím přenosem dat s událostmi.

location

string

Umístění prostředku

name

string

Název prostředku

properties.consumerGroupName

string

Název skupiny příjemců centra událostí, která obsahuje oddíly, ze kterých se události budou číst.

properties.eventHubName

string

Název centra událostí.

properties.keyName

string

Název klíče SAS, který uděluje službě Time Series Insights přístup k centru událostí. Zásady sdíleného přístupu pro tento klíč musí centru událostí udělit oprávnění Naslouchat.

properties.serviceBusNamespace

string

Název služby Service Bus, která obsahuje centrum událostí.

provisioningState

ProvisioningState

Stav zřizování prostředku.

tags

object

Značky prostředků

timestampPropertyName

string

Vlastnost události, která se použije jako časové razítko zdroje událostí. Pokud není pro timestampPropertyName zadána hodnota nebo pokud je zadána hodnota null nebo prázdný řetězec, použije se čas vytvoření události.

type

string

Typ prostředku

IngressStartAtType

Typ ingressStartAt, Může to být "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

Name Typ Description
CustomEnqueuedTime

string

EarliestAvailable

string

EventSourceCreationTime

string

IoTHubEventSourceCreateOrUpdateParameters

Parametry zadané pro operaci Vytvoření nebo aktualizace zdroje událostí pro zdroj událostí IoTHubu

Name Typ Description
creationTime

string

Čas vytvoření prostředku.

eventSourceResourceId

string

ID prostředku zdroje události v Azure Resource Manager.

ingressStartAt.time

string

ISO8601 datum a čas UTC s přesností sekund (milisekundy jsou volitelné) a určete datum a čas, které budou výchozím bodem pro využití událostí.

ingressStartAt.type

IngressStartAtType

Typ ingressStartAt, Může to být "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

kind string:

Microsoft.IoTHub

Druh zdroje událostí.

localTimestamp

LocalTimestamp

Objekt, který představuje místní vlastnost časového razítka. Obsahuje formát místního časového razítka, které je potřeba použít, a odpovídající informace o posunu časového pásma. Pokud hodnota není zadána pro localTimestamp nebo null, místní časové razítko nebude příchozím přenosem dat s událostmi.

location

string

Umístění prostředku.

properties.consumerGroupName

string

Název skupiny příjemců iot Hubu, která obsahuje oddíly, ze kterých se budou události číst.

properties.iotHubName

string

Název iot Hubu.

properties.keyName

string

Název klíče zásad sdíleného přístupu, který uděluje službě Time Series Insights přístup k iot Hubu. Tento klíč zásad sdíleného přístupu musí službě iot Hub udělit oprávnění připojení ke službě.

properties.sharedAccessKey

string

Hodnota klíče zásad sdíleného přístupu, která uděluje službě Time Series Insights přístup ke čtení k iot Hubu. Tato vlastnost se nezobrazuje v odpovědích zdroje událostí.

provisioningState

ProvisioningState

Stav zřizování prostředku.

tags

object

Páry klíč-hodnota dalších vlastností prostředku.

timestampPropertyName

string

Vlastnost události, která se použije jako časové razítko zdroje událostí. Pokud není pro timestampPropertyName zadána hodnota nebo pokud je zadána hodnota null nebo prázdný řetězec, použije se čas vytvoření události.

IoTHubEventSourceResource

Zdroj událostí, který přijímá data z Azure IoTHubu.

Name Typ Description
creationTime

string

Čas vytvoření prostředku.

eventSourceResourceId

string

ID prostředku zdroje události v Azure Resource Manager.

id

string

ID prostředku

ingressStartAt.time

string

ISO8601 datum a čas UTC s přesností sekund (milisekundy jsou volitelné) a určete datum a čas, které budou výchozím bodem pro využití událostí.

ingressStartAt.type

IngressStartAtType

Typ ingressStartAt, Může to být "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

kind string:

Microsoft.IoTHub

Druh zdroje událostí.

localTimestamp

LocalTimestamp

Objekt, který představuje místní vlastnost časového razítka. Obsahuje formát místního časového razítka, které je potřeba použít, a odpovídající informace o posunu časového pásma. Pokud hodnota není zadána pro localTimestamp nebo null, místní časové razítko nebude příchozím přenosem dat s událostmi.

location

string

Umístění prostředku

name

string

Název prostředku

properties.consumerGroupName

string

Název skupiny příjemců iot Hubu, která obsahuje oddíly, ze kterých se budou události číst.

properties.iotHubName

string

Název iot Hubu.

properties.keyName

string

Název klíče zásad sdíleného přístupu, který uděluje službě Time Series Insights přístup k iot Hubu. Tento klíč zásad sdíleného přístupu musí službě iot Hub udělit oprávnění připojení ke službě.

provisioningState

ProvisioningState

Stav zřizování prostředku.

tags

object

Značky prostředků

timestampPropertyName

string

Vlastnost události, která se použije jako časové razítko zdroje událostí. Pokud není pro timestampPropertyName zadána hodnota nebo pokud je zadána hodnota null nebo prázdný řetězec, použije se čas vytvoření události.

type

string

Typ prostředku

LocalTimestamp

Objekt, který představuje místní vlastnost časového razítka. Obsahuje formát místního časového razítka, které je potřeba použít, a odpovídající informace o posunu časového pásma. Pokud hodnota není zadána pro localTimestamp nebo null, místní časové razítko nebude příchozím přenosem dat s událostmi.

Name Typ Description
format

LocalTimestampFormat

Výčt, který představuje formát vlastnosti místního časového razítka, kterou je třeba nastavit.

timeZoneOffset

TimeZoneOffset

Objekt, který představuje informace o posunu pro zadaný místní formát časového razítka. Neměl by být zadán pro LocalTimestampFormat – Embedded.

LocalTimestampFormat

Výčt, který představuje formát vlastnosti místního časového razítka, kterou je třeba nastavit.

Name Typ Description
Embedded

string

ProvisioningState

Stav zřizování prostředku.

Name Typ Description
Accepted

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

TimeZoneOffset

Objekt, který představuje informace o posunu pro zadaný místní formát časového razítka. Neměl by být zadán pro LocalTimestampFormat – Embedded.

Name Typ Description
propertyName

string

Vlastnost události, která bude obsahovat informace o posunu pro výpočet místního časového razítka. Pokud je LocalTimestampFormat Iana, bude název vlastnosti obsahovat název sloupce, který obsahuje IANA Timezone Name (např. Americas/Los Angeles). Pokud je LocalTimestampFormat časový rozsah, obsahuje název vlastnosti, která obsahuje hodnoty představující posun (např. P1D nebo 1.00:00:00).