Event Sources - Update
Mises à jour la source d’événements avec le nom spécifié dans l’abonnement, le groupe de ressources et l’environnement spécifiés.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/eventSources/{eventSourceName}?api-version=2020-05-15
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
environment
|
path | True |
string |
Nom de l’environnement Time Series Insights associé au groupe de ressources spécifié. |
event
|
path | True |
string |
Nom de la source d’événement Time Series Insights associée à l’environnement spécifié. |
resource
|
path | True |
string |
Nom d’un groupe de ressources Azure. |
subscription
|
path | True |
string |
ID d’abonnement Azure. |
api-version
|
query | True |
string |
Version de l’API à utiliser avec la demande du client. |
Corps de la demande
Le corps de la requête peut être l’un des suivants :
Nom | Description |
---|---|
Event |
Paramètres fournis à l’opération Mettre à jour la source d’événements pour mettre à jour une source d’événements EventHub. |
Io |
Paramètres fournis à l’opération Mettre à jour la source d’événements pour mettre à jour une source d’événements IoTHub. |
EventHubEventSourceUpdateParameters
Paramètres fournis à l’opération Mettre à jour la source d’événements pour mettre à jour une source d’événements EventHub.
Nom | Obligatoire | Type | Description |
---|---|---|---|
kind | True |
string:
Microsoft. |
Type de la source d’événement. |
properties.sharedAccessKey |
string |
Valeur de la clé d’accès partagé qui accorde au service Time Series Insights l’accès en lecture au hub d’événements. Cette propriété n’est pas affichée dans les réponses sources d’événements. |
|
properties.timestampPropertyName |
string |
Propriété de l’événement qui sera utilisée comme horodateur de la source de l’événement. Si aucune valeur n’est spécifiée pour timestampPropertyName, ou si la valeur Null ou une chaîne vide est spécifiée, l’heure de création de l’événement sera utilisée. |
|
tags |
object |
Paires clé-valeur de propriétés supplémentaires pour la source d’événement. |
IoTHubEventSourceUpdateParameters
Paramètres fournis à l’opération Mettre à jour la source d’événements pour mettre à jour une source d’événements IoTHub.
Nom | Obligatoire | Type | Description |
---|---|---|---|
kind | True |
string:
Microsoft. |
Type de la source d’événement. |
properties.sharedAccessKey |
string |
Valeur de la clé d’accès partagé qui accorde au service Time Series Insights un accès en lecture au hub iot. Cette propriété n’est pas affichée dans les réponses sources d’événements. |
|
properties.timestampPropertyName |
string |
Propriété de l’événement qui sera utilisée comme horodateur de la source de l’événement. Si aucune valeur n’est spécifiée pour timestampPropertyName, ou si la valeur Null ou une chaîne vide est spécifiée, l’heure de création de l’événement sera utilisée. |
|
tags |
object |
Paires clé-valeur de propriétés supplémentaires pour la source d’événement. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK | EventSourceResource: |
La définition de la source d’événement a été correctement mise à jour et figure dans la réponse. |
Other Status Codes |
HTTP 404 (introuvable) : l’abonnement, le groupe de ressources, l’environnement ou la source d’événement est introuvable. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
UpdateEventSource
Sample Request
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": {
"someKey": "someValue"
},
"kind": "Microsoft.EventHub",
"properties": {
"eventSourceResourceId": "somePathInArm",
"serviceBusNamespace": "sbn",
"consumerGroupName": "cgn",
"eventHubName": "ehn",
"keyName": "managementKey",
"provisioningState": "Succeeded",
"creationTime": "2017-04-18T19:20:33.2288820Z",
"timestampPropertyName": "someOtherTimestampProperty",
"localTimestamp": {
"format": "TimeSpan",
"timeZoneOffset": {
"propertyName": "someEventPropertyName"
}
},
"ingressStartAt": {
"type": "EarliestAvailable"
}
}
}
Définitions
Nom | Description |
---|---|
Cloud |
Contient des informations sur une erreur d’API. |
Cloud |
Décrit une erreur d’API particulière avec un code d’erreur et un message. |
Event |
Source d’événements qui reçoit ses données d’un EventHub Azure. |
Event |
Paramètres fournis à l’opération Mettre à jour la source d’événements pour mettre à jour une source d’événements EventHub. |
Ingress |
Type de l’ingressStartAt, Il peut être « EarliestAvailable », « EventSourceCreationTime », « CustomEnqueuedTime ». |
Io |
Source d’événements qui reçoit ses données d’un Azure IoTHub. |
Io |
Paramètres fournis à l’opération Mettre à jour la source d’événements pour mettre à jour une source d’événements IoTHub. |
Local |
Objet qui représente la propriété d’horodatage local. Il contient le format de l’horodatage local qui doit être utilisé et les informations de décalage de fuseau horaire correspondantes. Si une valeur n’est pas spécifiée pour localTimestamp ou si elle est null, l’horodatage local n’est pas entré avec les événements. |
Local |
Énumération qui représente le format de la propriété d’horodatage local à définir. |
Provisioning |
État d’approvisionnement de la ressource. |
Time |
Objet qui représente les informations de décalage pour le format d’horodatage local spécifié. Ne doit pas être spécifié pour LocalTimestampFormat - Embedded. |
CloudError
Contient des informations sur une erreur d’API.
Nom | Type | Description |
---|---|---|
error |
Décrit une erreur d’API particulière avec un code d’erreur et un message. |
CloudErrorBody
Décrit une erreur d’API particulière avec un code d’erreur et un message.
Nom | Type | Description |
---|---|---|
code |
string |
Code d’erreur qui décrit la condition d’erreur plus précisément qu’un code http status. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques. |
details |
Contient les erreurs imbriquées liées à cette erreur. |
|
message |
string |
Message qui décrit l’erreur en détail et fournit des informations de débogage. |
target |
string |
Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur). |
EventHubEventSourceResource
Source d’événements qui reçoit ses données d’un EventHub Azure.
Nom | Type | Description |
---|---|---|
creationTime |
string |
Heure de création de la ressource. |
eventSourceResourceId |
string |
ID de ressource de la source d’événement dans Azure Resource Manager. |
id |
string |
ID de ressource |
ingressStartAt.time |
string |
ISO8601 datetime UTC avec une précision en secondes (les millisecondes sont facultatives), en spécifiant la date et l’heure qui seront le point de départ pour la consommation des événements. |
ingressStartAt.type |
Type de l’ingressStartAt, Il peut être « EarliestAvailable », « EventSourceCreationTime », « CustomEnqueuedTime ». |
|
kind |
string:
Microsoft. |
Type de la source d’événement. |
localTimestamp |
Objet qui représente la propriété d’horodatage local. Il contient le format de l’horodatage local qui doit être utilisé et les informations de décalage de fuseau horaire correspondantes. Si une valeur n’est pas spécifiée pour localTimestamp ou si elle est null, l’horodatage local n’est pas entré avec les événements. |
|
location |
string |
Emplacement de la ressource |
name |
string |
Nom de la ressource |
properties.consumerGroupName |
string |
Nom du groupe de consommateurs du hub d’événements qui contient les partitions à partir desquelles les événements seront lus. |
properties.eventHubName |
string |
Nom du hub d’événements. |
properties.keyName |
string |
Nom de la clé SAP qui accorde au service Time Series Insights l’accès au hub d’événements. Les stratégies d’accès partagé pour cette clé doivent accorder des autorisations « Écouter » au hub d’événements. |
properties.serviceBusNamespace |
string |
Nom du service bus qui contient le hub d’événements. |
provisioningState |
État d’approvisionnement de la ressource. |
|
tags |
object |
Balises de ressource |
timestampPropertyName |
string |
Propriété de l’événement qui sera utilisée comme horodateur de la source de l’événement. Si aucune valeur n’est spécifiée pour timestampPropertyName, ou si la valeur Null ou une chaîne vide est spécifiée, l’heure de création de l’événement sera utilisée. |
type |
string |
Type de ressource |
EventHubEventSourceUpdateParameters
Paramètres fournis à l’opération Mettre à jour la source d’événements pour mettre à jour une source d’événements EventHub.
Nom | Type | Description |
---|---|---|
kind |
string:
Microsoft. |
Type de la source d’événement. |
properties.sharedAccessKey |
string |
Valeur de la clé d’accès partagé qui accorde au service Time Series Insights l’accès en lecture au hub d’événements. Cette propriété n’est pas affichée dans les réponses sources d’événements. |
properties.timestampPropertyName |
string |
Propriété de l’événement qui sera utilisée comme horodateur de la source de l’événement. Si aucune valeur n’est spécifiée pour timestampPropertyName, ou si la valeur Null ou une chaîne vide est spécifiée, l’heure de création de l’événement sera utilisée. |
tags |
object |
Paires clé-valeur de propriétés supplémentaires pour la source d’événement. |
IngressStartAtType
Type de l’ingressStartAt, Il peut être « EarliestAvailable », « EventSourceCreationTime », « CustomEnqueuedTime ».
Nom | Type | Description |
---|---|---|
CustomEnqueuedTime |
string |
|
EarliestAvailable |
string |
|
EventSourceCreationTime |
string |
IoTHubEventSourceResource
Source d’événements qui reçoit ses données d’un Azure IoTHub.
Nom | Type | Description |
---|---|---|
creationTime |
string |
Heure de création de la ressource. |
eventSourceResourceId |
string |
ID de ressource de la source d’événement dans Azure Resource Manager. |
id |
string |
ID de ressource |
ingressStartAt.time |
string |
ISO8601 datetime UTC avec une précision en secondes (les millisecondes sont facultatives), en spécifiant la date et l’heure qui seront le point de départ pour la consommation des événements. |
ingressStartAt.type |
Type de l’ingressStartAt, Il peut être « EarliestAvailable », « EventSourceCreationTime », « CustomEnqueuedTime ». |
|
kind |
string:
Microsoft. |
Type de la source d’événement. |
localTimestamp |
Objet qui représente la propriété d’horodatage local. Il contient le format de l’horodatage local qui doit être utilisé et les informations de décalage de fuseau horaire correspondantes. Si une valeur n’est pas spécifiée pour localTimestamp ou si elle est null, l’horodatage local n’est pas entré avec les événements. |
|
location |
string |
Emplacement de la ressource |
name |
string |
Nom de la ressource |
properties.consumerGroupName |
string |
Nom du groupe de consommateurs du hub iot qui contient les partitions à partir desquelles les événements seront lus. |
properties.iotHubName |
string |
Nom du hub iot. |
properties.keyName |
string |
Nom de la clé de stratégie d’accès partagé qui accorde au service Time Series Insights l’accès au hub iot. Cette clé de stratégie d’accès partagé doit accorder des autorisations de connexion de service au hub iot. |
provisioningState |
État d’approvisionnement de la ressource. |
|
tags |
object |
Balises de ressource |
timestampPropertyName |
string |
Propriété de l’événement qui sera utilisée comme horodateur de la source de l’événement. Si aucune valeur n’est spécifiée pour timestampPropertyName, ou si la valeur Null ou une chaîne vide est spécifiée, l’heure de création de l’événement sera utilisée. |
type |
string |
Type de ressource |
IoTHubEventSourceUpdateParameters
Paramètres fournis à l’opération Mettre à jour la source d’événements pour mettre à jour une source d’événements IoTHub.
Nom | Type | Description |
---|---|---|
kind |
string:
Microsoft. |
Type de la source d’événement. |
properties.sharedAccessKey |
string |
Valeur de la clé d’accès partagé qui accorde au service Time Series Insights un accès en lecture au hub iot. Cette propriété n’est pas affichée dans les réponses sources d’événements. |
properties.timestampPropertyName |
string |
Propriété de l’événement qui sera utilisée comme horodateur de la source de l’événement. Si aucune valeur n’est spécifiée pour timestampPropertyName, ou si la valeur Null ou une chaîne vide est spécifiée, l’heure de création de l’événement sera utilisée. |
tags |
object |
Paires clé-valeur de propriétés supplémentaires pour la source d’événement. |
LocalTimestamp
Objet qui représente la propriété d’horodatage local. Il contient le format de l’horodatage local qui doit être utilisé et les informations de décalage de fuseau horaire correspondantes. Si une valeur n’est pas spécifiée pour localTimestamp ou si elle est null, l’horodatage local n’est pas entré avec les événements.
Nom | Type | Description |
---|---|---|
format |
Énumération qui représente le format de la propriété d’horodatage local à définir. |
|
timeZoneOffset |
Objet qui représente les informations de décalage pour le format d’horodatage local spécifié. Ne doit pas être spécifié pour LocalTimestampFormat - Embedded. |
LocalTimestampFormat
Énumération qui représente le format de la propriété d’horodatage local à définir.
Nom | Type | Description |
---|---|---|
Embedded |
string |
ProvisioningState
État d’approvisionnement de la ressource.
Nom | Type | Description |
---|---|---|
Accepted |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
TimeZoneOffset
Objet qui représente les informations de décalage pour le format d’horodatage local spécifié. Ne doit pas être spécifié pour LocalTimestampFormat - Embedded.
Nom | Type | Description |
---|---|---|
propertyName |
string |
Propriété d’événement qui contiendra les informations de décalage pour calculer l’horodatage local. Lorsque LocalTimestampFormat est Iana, le nom de la propriété contient le nom de la colonne qui contient le nom du fuseau horaire IANA (par exemple, Americas/Los Angeles). Lorsque LocalTimestampFormat est Timespan, il contient le nom de la propriété qui contient des valeurs représentant le décalage (par exemple, P1D ou 1.00 :00 :00) |