Partager via

Espace de noms Azure Event Grid (préversion) en tant que source Event Grid

  • Article

Cet article décrit les propriétés et le schéma des événements Azure Event Grid espace de noms. Pour une présentation des schémas d’événements, consultez Schéma d’événements Azure Event Grid.

Types d’événement disponibles

L’espace de noms Azure Event Grid (préversion) publie les types d’événements suivants :

Type d'événement Description
Microsoft.EventGrid.MQTTClientSessionConnected Publié quand la session d’un client MQTT est connectée à Event Grid.
Microsoft.EventGrid.MQTTClientSessionDisconnected Publié quand la session d’un client MQTT est déconnectée d’Event Grid.
Microsoft.EventGrid.MQTTClientCreatedOrUpdated Publié lorsqu’un client MQTT est créé ou mis à jour dans l’espace de noms Event Grid.
Microsoft.EventGrid.MQTTClientDeleted Publié lorsqu’un client MQTT est supprimé de l’espace de noms Event Grid.

Exemple d’événement

Cet exemple d’événement montre le schéma d’un événement déclenché lorsque la session d’un client MQTT est connectée à Event Grid :

[{
  "specversion": "1.0",
  "id": "5249c38a-a048-46dd-8f60-df34fcdab06c",
  "time": "2023-07-29T01:23:49.6454046Z",
  "type": "Microsoft.EventGrid.MQTTClientSessionConnected",
  "source": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/myrg/providers/Microsoft.EventGrid/namespaces/myns",
  "subject": "clients/client1/sessions/session1",
  "data": {
    "namespaceName": "myns",
    "clientAuthenticationName": "client1",
    "clientSessionName": "session1",
    "sequenceNumber": 1
  }
}]

Cet exemple d’événement montre le schéma d’un événement déclenché lorsque la session d’un client MQTT est déconnectée d’Event Grid :

[{
  "specversion": "1.0",
  "id": "e30e5174-787d-4e19-8812-580148bfcf7b",
  "time": "2023-07-29T01:27:40.2446871Z",
  "type": "Microsoft.EventGrid.MQTTClientSessionDisconnected",
  "source": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/myrg/providers/Microsoft.EventGrid/namespaces/myns",
  "subject": "clients/client1/sessions/session1",
  "data": {
    "namespaceName": "myns",
    "clientAuthenticationName": "client1",
    "clientSessionName": "session1",
    "sequenceNumber": 1,
    "disconnectionReason": "ClientInitiatedDisconnect"
  }
}]

Cet exemple d’événement montre le schéma d’un événement déclenché lorsqu’un client MQTT est créé ou mis à jour dans l’espace de noms Event Grid :

[{
  "specversion": "1.0",
  "id": "383d1562-c95f-4095-936c-688e72c6b2bb",
  "time": "2023-07-29T01:14:35.8928724Z",
  "type": "Microsoft.EventGrid.MQTTClientCreatedOrUpdated",
  "source": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/myrg/providers/Microsoft.EventGrid/namespaces/myns",
  "subject": "clients/client1",
  "data": {
    "createdOn": "2023-07-29T01:14:34.2048108Z",
    "updatedOn": "2023-07-29T01:14:34.2048108Z",
    "namespaceName": "myns",
    "clientName": "client1",
    "clientAuthenticationName": "client1",
    "state": "Enabled",
    "attributes": {
      "attribute1": "value1"
    }
  }
}]

Cet exemple d’événement montre le schéma d’un événement déclenché lorsqu’un client MQTT est supprimé de l’espace de noms Event Grid :

[{
  "specversion": "1.0",
  "id": "2a93aaf9-66c2-4f8e-9ba3-8d899c10bf17",
  "time": "2023-07-29T01:30:52.5620566Z",
  "type": "Microsoft.EventGrid.MQTTClientDeleted",
  "source": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/myrg/providers/Microsoft.EventGrid/namespaces/myns",
  "subject": "clients/client1",
  "data": {
    "namespaceName": "myns",
    "clientName": "client1",
    "clientAuthenticationName": "client1"
  }
}]

Propriétés d’événement

Tous les événements contiennent les mêmes données de niveau supérieur :

Propriété Type Description
id string Identificateur unique de l’événement.
source string Chemin d’accès complet à la source de l’événement. Ce champ n’est pas modifiable. Event Grid fournit cette valeur.
subject string Chemin de l’objet de l’événement, défini par le serveur de publication.
type string Un des types d’événements inscrits pour cette source d’événement.
time string L’heure à quelle l’événement est généré selon l’heure UTC du fournisseur.
data object Données d’événement de l’espace de noms Event Grid.
specversion string Version de la spécification de schéma CloudEvents.

L’objet de données contient les propriétés suivantes :

Propriété Type Description
namespaceName string Nom de l’espace de noms Event Grid où le client MQTT a été connecté ou déconnecté.
clientAuthenticationName string Identificateur unique pour le client MQTT que le client présente au service pour l’authentification. Cette chaîne respectant la casse peut avoir jusqu’à 128 caractères et prend en charge les caractères UTF-8.
clientSessionName string Identificateur unique pour la session du client MQTT. Cette chaîne respectant la casse peut avoir jusqu’à 128 caractères et prend en charge les caractères UTF-8.
sequenceNumber long Nombre qui permet d’indiquer l’ordre des événements connectés ou déconnectés de session cliente MQTT. Le dernier événement aura un numéro de séquence plus élevé que l’événement précédent.
disconnectionReason string Raison de la déconnexion de la session du client MQTT. La valeur peut être l’une des valeurs de la table des raisons de déconnexion.
createdOn string Heure à laquelle la ressource du client est créée selon l’heure UTC du fournisseur.
updatedOn string Heure à laquelle la ressource du client est mise à jour selon l’heure UTC du fournisseur. Si la ressource du client n’a jamais été mise à jour, cette valeur est identique à la valeur de la propriété « createdOn »
clientName string Heure à laquelle la ressource du client est mise à jour selon l’heure UTC du fournisseur. Si la ressource du client n’a jamais été mise à jour, cette valeur est identique à la valeur de la propriété « createdOn ».
state string État configuré du client. La valeur peut être Activé ou Désactivé.
attributes string Tableau d’attributs de paire clé-valeur attribués à la ressource du client.

Raisons de la déconnexion :

La liste suivante détaille les différentes valeurs de disconnectionReason et leur description :

Raison de la déconnexion Description
ClientAuthenticationError le client a été déconnecté pour des raisons d’authentification (par exemple, le certificat a expiré, le client a été désactivé ou la configuration du client a été modifiée)
ClientAuthorizationError le client a été déconnecté pour des raisons d’autorisation (par exemple, en raison d’une modification de la configuration des espaces de rubrique, des liaisons d’autorisation ou des groupes de clients)
ClientError le client a envoyé une demande incorrecte ou utilisé l’une des fonctionnalités non prises en charge qui a entraîné l’arrêt de la connexion par le service.
ClientInitiatedDisconnect le client initie une déconnexion normale via un paquet DISCONNECT pour MQTT ou un cadre fermé pour MQTT sur WebSocket.
ConnectionLost la connexion client-serveur est perdue.
IpForbidden l’adresse IP du client est bloquée par le filtre IP ou la configuration des liaisons privées.
QuotaExceeded le client a dépassé une ou plusieurs des limites de limitation qui ont entraîné l’arrêt de la connexion par le service.
ServerError la connexion a été interrompue en raison d’une erreur de serveur inattendue
ServerInitiatedDisconnect le serveur lance une déconnexion normale pour n’importe quelle raison opérationnelle
SessionOverflow la file d’attente du client pour les messages QoS1 non acquittés a atteint sa limite, ce qui a entraîné l’arrêt de la connexion par le serveur
SessionTakenOver le client s’est reconnecté avec le même nom d’authentification, ce qui a entraîné l’arrêt de la connexion précédente.

Étapes suivantes