Partager via


Iot Hub Resource - Get

Obtenez les métadonnées non liées à la sécurité d’un hub IoT.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2023-06-30

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
path True

string

Nom du groupe de ressources qui contient le hub IoT.

resourceName
path True

string

Nom du hub IoT.

subscriptionId
path True

string

Identificateur de l’abonnement.

api-version
query True

string

Version de l’API.

Réponses

Nom Type Description
200 OK

IotHubDescription

Le corps contient toutes les propriétés non liées à la sécurité du hub IoT. Les propriétés liées à la sécurité sont définies sur null.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

IotHubResource_Get

Exemple de requête

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub?api-version=2023-06-30

Exemple de réponse

{
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
  "name": "testHub",
  "type": "Microsoft.Devices/IotHubs",
  "location": "centraluseuap",
  "tags": {},
  "etag": "AAAAAAFD6M4=",
  "properties": {
    "state": "Active",
    "provisioningState": "Succeeded",
    "ipFilterRules": [
      {
        "filterName": "rule1",
        "action": "Accept",
        "ipMask": "131.117.159.53"
      },
      {
        "filterName": "rule2",
        "action": "Accept",
        "ipMask": "157.55.59.128/25"
      }
    ],
    "networkRuleSets": {
      "defaultAction": "Deny",
      "applyToBuiltInEventHubEndpoint": true,
      "ipRules": [
        {
          "filterName": "rule1",
          "action": "Allow",
          "ipMask": "131.117.159.53"
        },
        {
          "filterName": "rule2",
          "action": "Allow",
          "ipMask": "157.55.59.128/25"
        }
      ]
    },
    "hostName": "iot-dps-cit-hub-1.azure-devices.net",
    "eventHubEndpoints": {
      "events": {
        "retentionTimeInDays": 1,
        "partitionCount": 2,
        "partitionIds": [
          "0",
          "1"
        ],
        "path": "iot-dps-cit-hub-1",
        "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/"
      }
    },
    "routing": {
      "endpoints": {
        "serviceBusQueues": [],
        "serviceBusTopics": [],
        "eventHubs": [],
        "storageContainers": []
      },
      "routes": [],
      "fallbackRoute": {
        "source": "DeviceMessages",
        "condition": "true",
        "endpointNames": [
          "events"
        ],
        "isEnabled": true
      }
    },
    "storageEndpoints": {
      "$default": {
        "sasTtlAsIso8601": "PT1H",
        "connectionString": "",
        "containerName": ""
      }
    },
    "messagingEndpoints": {
      "fileNotifications": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "enableFileUploadNotifications": false,
    "cloudToDevice": {
      "maxDeliveryCount": 10,
      "defaultTtlAsIso8601": "PT1H",
      "feedback": {
        "lockDurationAsIso8601": "PT1M",
        "ttlAsIso8601": "PT1H",
        "maxDeliveryCount": 10
      }
    },
    "features": "None",
    "locations": [
      {
        "location": "West US",
        "role": "primary"
      },
      {
        "location": "East US",
        "role": "secondary"
      }
    ],
    "minTlsVersion": "1.2"
  },
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdAt": "2021-01-30T00:28:38.963Z"
  }
}

Définitions

Nom Description
AccessRights

Autorisations attribuées à la stratégie d’accès partagé.

ArmIdentity
ArmUserIdentity
AuthenticationType

Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.

authenticationType

Méthode utilisée pour s’authentifier auprès du point de terminaison de file d’attente Service Bus

Capabilities

Fonctionnalités et fonctionnalités activées pour le hub IoT.

CloudToDeviceProperties

Propriétés de messagerie cloud-à-appareil IoT Hub.

createdByType

Type d’identité qui a créé la ressource.

DefaultAction

Action par défaut pour l’ensemble de règles réseau

EnrichmentProperties

Propriétés d’un enrichissement que votre hub IoT applique aux messages remis aux points de terminaison.

ErrorDetails

Détails de l’erreur.

EventHubProperties

Propriétés du point de terminaison compatible Event Hub provisionné utilisé par le hub IoT.

FallbackRouteProperties

Propriétés de l’itinéraire de secours. IoT Hub utilise ces propriétés lorsqu’il achemine les messages vers le point de terminaison de secours.

FeedbackProperties

Propriétés de la file d’attente de commentaires pour les messages cloud-à-appareil.

IotHubDescription

Description du hub IoT.

IotHubLocationDescription

Représentation publique de l’un des emplacements où une ressource est provisionnée.

IotHubProperties

Propriétés d’un hub IoT.

IotHubReplicaRoleType

Le rôle de la région peut être principal ou secondaire. La région primaire est l’endroit où le hub IoT est actuellement approvisionné. La région secondaire est la région jumelée à la récupération d’urgence Azure (DR) et également la région vers laquelle le hub IoT peut basculer.

IotHubSku

Nom de la référence SKU.

IotHubSkuInfo

Informations sur la référence SKU du hub IoT.

IotHubSkuTier

Niveau de facturation pour le hub IoT.

IpFilterActionType

Action souhaitée pour les requêtes capturées par cette règle.

IpFilterRule

Règles de filtre IP pour le hub IoT.

ManagedIdentity

Propriétés de l’identité managée.

MessagingEndpointProperties

Propriétés des points de terminaison de messagerie utilisés par ce hub IoT.

NetworkRuleIPAction

Action de filtre IP

NetworkRuleSetIpRule

Règle IP à appliquer dans le cadre de l’ensemble de règles réseau

NetworkRuleSetProperties

Propriétés de l’ensemble de règles réseau d’IotHub

PrivateEndpoint

Propriété de point de terminaison privé d’une connexion de point de terminaison privé

PrivateEndpointConnection

Connexion de point de terminaison privé d’un IotHub

PrivateEndpointConnectionProperties

Propriétés d’une connexion de point de terminaison privé

PrivateLinkServiceConnectionState

État actuel d’une connexion de point de terminaison privé

PrivateLinkServiceConnectionStatus

Status d’une connexion de point de terminaison privé

PublicNetworkAccess

Si les demandes provenant du réseau public sont autorisées

ResourceIdentityType

Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » comprend à la fois une identité créée implicitement et un ensemble d’identités attribuées par l’utilisateur. Le type « None » supprime toutes les identités du service.

RouteProperties

Propriétés d’une règle de routage que votre hub IoT utilise pour acheminer les messages vers les points de terminaison.

RoutingCosmosDBSqlApiProperties

Propriétés liées à un point de terminaison de conteneur sql cosmos DB.

RoutingEndpoints

Propriétés liées aux points de terminaison personnalisés vers lesquels votre hub IoT achemine les messages en fonction des règles de routage. Un maximum de 10 points de terminaison personnalisés sont autorisés pour tous les types de points de terminaison pour les hubs payants et un seul point de terminaison personnalisé est autorisé sur tous les types de points de terminaison pour les hubs gratuits.

RoutingEventHubProperties

Propriétés liées à un point de terminaison de hub d’événements.

RoutingProperties

Propriétés liées au routage du hub IoT. Consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

RoutingServiceBusQueueEndpointProperties

Propriétés liées aux types de points de terminaison de file d’attente Service Bus.

RoutingServiceBusTopicEndpointProperties

Propriétés liées aux types de points de terminaison de rubrique Service Bus.

RoutingSource

Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.

RoutingStorageContainerProperties

Propriétés liées à un point de terminaison de conteneur de stockage.

SharedAccessSignatureAuthorizationRule

Propriétés d’une stratégie d’accès partagé IoT Hub.

StorageEndpointProperties

Propriétés du point de terminaison stockage Azure pour le chargement de fichiers.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

AccessRights

Autorisations attribuées à la stratégie d’accès partagé.

Nom Type Description
DeviceConnect

string

RegistryRead

string

RegistryRead, DeviceConnect

string

RegistryRead, RegistryWrite

string

RegistryRead, RegistryWrite, DeviceConnect

string

RegistryRead, RegistryWrite, ServiceConnect

string

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

string

RegistryRead, ServiceConnect

string

RegistryRead, ServiceConnect, DeviceConnect

string

RegistryWrite

string

RegistryWrite, DeviceConnect

string

RegistryWrite, ServiceConnect

string

RegistryWrite, ServiceConnect, DeviceConnect

string

ServiceConnect

string

ServiceConnect, DeviceConnect

string

ArmIdentity

Nom Type Description
principalId

string

Principal Id

tenantId

string

ID client

type

ResourceIdentityType

Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » comprend à la fois une identité créée implicitement et un ensemble d’identités attribuées par l’utilisateur. Le type « None » supprime toutes les identités du service.

userAssignedIdentities

<string,  ArmUserIdentity>

ArmUserIdentity

Nom Type Description
clientId

string

principalId

string

AuthenticationType

Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.

Nom Type Description
identityBased

string

keyBased

string

authenticationType

Méthode utilisée pour s’authentifier auprès du point de terminaison de file d’attente Service Bus

Nom Type Description
identityBased

string

keyBased

string

Capabilities

Fonctionnalités et fonctionnalités activées pour le hub IoT.

Nom Type Description
DeviceManagement

string

None

string

CloudToDeviceProperties

Propriétés de messagerie cloud-à-appareil IoT Hub.

Nom Type Description
defaultTtlAsIso8601

string

Durée de vie par défaut pour les messages cloud-à-appareil dans la file d’attente d’appareil. Voir https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

feedback

FeedbackProperties

Propriétés de la file d’attente de commentaires pour les messages cloud-à-appareil.

maxDeliveryCount

integer

Nombre maximal de remises pour les messages cloud-à-appareil dans la file d’attente des appareils. Voir https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DefaultAction

Action par défaut pour l’ensemble de règles réseau

Nom Type Description
Allow

string

Deny

string

EnrichmentProperties

Propriétés d’un enrichissement que votre hub IoT applique aux messages remis aux points de terminaison.

Nom Type Description
endpointNames

string[]

Liste des points de terminaison pour lesquels l’enrichissement est appliqué au message.

key

string

Clé ou nom de la propriété d’enrichissement.

value

string

Valeur de la propriété d’enrichissement.

ErrorDetails

Détails de l’erreur.

Nom Type Description
code

string

Code d'erreur.

details

string

Détails de l’erreur.

httpStatusCode

string

Code d’état HTTP.

message

string

Message d’erreur.

EventHubProperties

Propriétés du point de terminaison compatible Event Hub provisionné utilisé par le hub IoT.

Nom Type Description
endpoint

string

Point de terminaison compatible avec Event Hub.

partitionCount

integer

Nombre de partitions pour la réception de messages appareil-à-cloud dans le point de terminaison compatible Event Hub. Voir https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

partitionIds

string[]

Id de partition dans le point de terminaison compatible Avec Event Hub.

path

string

Nom compatible avec Event Hub.

retentionTimeInDays

integer

Durée de rétention des messages appareil-à-cloud en jours. Consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

FallbackRouteProperties

Propriétés de l’itinéraire de secours. IoT Hub utilise ces propriétés lorsqu’il achemine les messages vers le point de terminaison de secours.

Nom Type Description
condition

string

Condition évaluée pour appliquer l’itinéraire de secours. Si la condition n’est pas fournie, elle est évaluée à true par défaut. Pour plus d’informations grammaticales, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

Liste des points de terminaison vers lesquels les messages qui satisfont à la condition sont routés. Actuellement, un seul point de terminaison est autorisé.

isEnabled

boolean

Permet de spécifier si l’itinéraire de secours est activé.

name

string

Nom de l'itinéraire. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union, une longueur maximale de 64 caractères et doit être unique.

source

RoutingSource

Source à laquelle la règle de routage doit être appliquée. Par exemple, DeviceMessages

FeedbackProperties

Propriétés de la file d’attente de commentaires pour les messages cloud-à-appareil.

Nom Type Description
lockDurationAsIso8601

string

Durée de verrouillage de la file d’attente de commentaires. Voir https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

maxDeliveryCount

integer

Nombre de fois où le hub IoT tente de remettre un message sur la file d’attente de commentaires. Voir https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

ttlAsIso8601

string

Période pendant laquelle un message est disponible pour être consommé avant son expiration par le hub IoT. Voir https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

IotHubDescription

Description du hub IoT.

Nom Type Description
etag

string

Le champ Etag n’est pas obligatoire. Si elle est fournie dans le corps de la réponse, elle doit également être fournie en tant qu’en-tête conformément à la convention ETag normale.

id

string

Identificateur de ressource.

identity

ArmIdentity

Identités managées pour IotHub.

location

string

Emplacement de la ressource.

name

string

Nom de la ressource.

properties

IotHubProperties

Propriétés IotHub

sku

IotHubSkuInfo

Informations sur la référence SKU IotHub

systemData

systemData

Métadonnées système relatives à cette ressource.

tags

object

Étiquettes de la ressource.

type

string

Type de ressource.

IotHubLocationDescription

Représentation publique de l’un des emplacements où une ressource est provisionnée.

Nom Type Description
location

string

Nom de la région Azure

role

IotHubReplicaRoleType

Le rôle de la région peut être principal ou secondaire. La région primaire est l’endroit où le hub IoT est actuellement approvisionné. La région secondaire est la région jumelée à la récupération d’urgence Azure (DR) et également la région vers laquelle le hub IoT peut basculer.

IotHubProperties

Propriétés d’un hub IoT.

Nom Type Description
allowedFqdnList

string[]

Liste des noms de domaine complets (FQDN) autorisés pour les sorties à partir d’Iot Hub.

authorizationPolicies

SharedAccessSignatureAuthorizationRule[]

Les stratégies d’accès partagé que vous pouvez utiliser pour sécuriser une connexion au hub IoT.

cloudToDevice

CloudToDeviceProperties

Propriétés de messagerie cloud-à-appareil IoT Hub.

comments

string

Commentaires du hub IoT.

disableDeviceSAS

boolean

Si la valeur est true, toutes les clés SAP étendues à l’appareil (y compris les appareils Edge, mais à l’exception des modules) ne peuvent pas être utilisées pour l’authentification.

disableLocalAuth

boolean

Si la valeur est true, les jetons SAS avec des clés SAP étendues au hub Iot ne peuvent pas être utilisés pour l’authentification.

disableModuleSAS

boolean

Si la valeur est true, toutes les clés SAP étendues au module ne peuvent pas être utilisées pour l’authentification.

enableDataResidency

boolean

Lorsqu’elle est définie sur true, cette propriété active la résidence des données, ce qui désactive la récupération d’urgence.

enableFileUploadNotifications

boolean

Si la valeur est True, les notifications de chargement de fichiers sont activées.

eventHubEndpoints

<string,  EventHubProperties>

Propriétés de point de terminaison compatibles avec Event Hub. Les seules clés possibles de ce dictionnaire sont les événements. Cette clé doit être présente dans le dictionnaire lors des appels de création ou de mise à jour pour le hub IoT.

features

Capabilities

Fonctionnalités activées pour le hub IoT.

hostName

string

Nom de l’hôte.

ipFilterRules

IpFilterRule[]

Règles de filtre IP.

locations

IotHubLocationDescription[]

Emplacement principal et secondaire pour iot Hub

messagingEndpoints

<string,  MessagingEndpointProperties>

Propriétés du point de terminaison de messagerie pour la file d’attente de notification de chargement de fichier.

minTlsVersion

string

Spécifie la version TLS minimale à prendre en charge pour ce hub. Peut être défini sur « 1.2 » pour que les clients qui utilisent une version TLS inférieure à 1.2 soient rejetés.

networkRuleSets

NetworkRuleSetProperties

Propriétés de l’ensemble de règles réseau d’IotHub

privateEndpointConnections

PrivateEndpointConnection[]

Connexions de point de terminaison privé créées sur cet IotHub

provisioningState

string

État d’approvisionnement.

publicNetworkAccess

PublicNetworkAccess

Si les demandes provenant du réseau public sont autorisées

restrictOutboundNetworkAccess

boolean

Si la valeur est true, la sortie d’IotHub est limitée aux noms de domaine complets autorisés configurés via allowedFqdnList.

routing

RoutingProperties

Propriétés liées au routage du hub IoT. Consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

state

string

État du hub.

storageEndpoints

<string,  StorageEndpointProperties>

Liste des points de terminaison stockage Azure dans lesquels vous pouvez charger des fichiers. Actuellement, vous ne pouvez configurer qu’un seul compte de stockage Azure et dont la clé doit être $default. La spécification de plusieurs comptes de stockage entraîne la levée d’une erreur. Si vous ne spécifiez pas de valeur pour cette propriété lorsque la propriété enableFileUploadNotifications a la valeur True, une erreur est levée.

IotHubReplicaRoleType

Le rôle de la région peut être principal ou secondaire. La région primaire est l’endroit où le hub IoT est actuellement approvisionné. La région secondaire est la région jumelée à la récupération d’urgence Azure (DR) et également la région vers laquelle le hub IoT peut basculer.

Nom Type Description
primary

string

secondary

string

IotHubSku

Nom de la référence SKU.

Nom Type Description
B1

string

B2

string

B3

string

F1

string

S1

string

S2

string

S3

string

IotHubSkuInfo

Informations sur la référence SKU du hub IoT.

Nom Type Description
capacity

integer

Nombre d’unités IoT Hub approvisionnées. Voir https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

name

IotHubSku

Nom de la référence SKU.

tier

IotHubSkuTier

Niveau de facturation du hub IoT.

IotHubSkuTier

Niveau de facturation pour le hub IoT.

Nom Type Description
Basic

string

Free

string

Standard

string

IpFilterActionType

Action souhaitée pour les requêtes capturées par cette règle.

Nom Type Description
Accept

string

Reject

string

IpFilterRule

Règles de filtre IP pour le hub IoT.

Nom Type Description
action

IpFilterActionType

Action souhaitée pour les demandes capturées par cette règle.

filterName

string

Nom de la règle de filtre IP.

ipMask

string

Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.

ManagedIdentity

Propriétés de l’identité managée.

Nom Type Description
userAssignedIdentity

string

Identité affectée par l’utilisateur.

MessagingEndpointProperties

Propriétés des points de terminaison de messagerie utilisés par ce hub IoT.

Nom Type Description
lockDurationAsIso8601

string

Durée du verrou. Voir https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

maxDeliveryCount

integer

Nombre de fois où le hub IoT tente de remettre un message. Voir https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

ttlAsIso8601

string

Période pendant laquelle un message est disponible pour être consommé avant son expiration par le hub IoT. Voir https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

Action de filtre IP

Nom Type Description
Allow

string

NetworkRuleSetIpRule

Règle IP à appliquer dans le cadre de l’ensemble de règles réseau

Nom Type Valeur par défaut Description
action

NetworkRuleIPAction

Allow

Action de filtre IP

filterName

string

Nom de la règle de filtre IP.

ipMask

string

Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.

NetworkRuleSetProperties

Propriétés de l’ensemble de règles réseau d’IotHub

Nom Type Valeur par défaut Description
applyToBuiltInEventHubEndpoint

boolean

Si la valeur est True, l’ensemble de règles réseau est également appliqué à BuiltIn EventHub EndPoint d’IotHub

defaultAction

DefaultAction

Deny

Action par défaut pour l’ensemble de règles réseau

ipRules

NetworkRuleSetIpRule[]

Liste des règles IP

PrivateEndpoint

Propriété de point de terminaison privé d’une connexion de point de terminaison privé

Nom Type Description
id

string

Identificateur de ressource.

PrivateEndpointConnection

Connexion de point de terminaison privé d’un IotHub

Nom Type Description
id

string

Identificateur de ressource.

name

string

Nom de la ressource.

properties

PrivateEndpointConnectionProperties

Propriétés d’une connexion de point de terminaison privé

type

string

Type de ressource.

PrivateEndpointConnectionProperties

Propriétés d’une connexion de point de terminaison privé

Nom Type Description
privateEndpoint

PrivateEndpoint

Propriété de point de terminaison privé d’une connexion de point de terminaison privé

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

État actuel d’une connexion de point de terminaison privé

PrivateLinkServiceConnectionState

État actuel d’une connexion de point de terminaison privé

Nom Type Description
actionsRequired

string

Actions requises pour une connexion de point de terminaison privé

description

string

Description de l’état actuel d’une connexion de point de terminaison privé

status

PrivateLinkServiceConnectionStatus

Status d’une connexion de point de terminaison privé

PrivateLinkServiceConnectionStatus

Status d’une connexion de point de terminaison privé

Nom Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

Si les demandes provenant du réseau public sont autorisées

Nom Type Description
Disabled

string

Enabled

string

ResourceIdentityType

Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » comprend à la fois une identité créée implicitement et un ensemble d’identités attribuées par l’utilisateur. Le type « None » supprime toutes les identités du service.

Nom Type Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RouteProperties

Propriétés d’une règle de routage que votre hub IoT utilise pour acheminer les messages vers les points de terminaison.

Nom Type Description
condition

string

Condition évaluée pour appliquer la règle de routage. Si aucune condition n’est fournie, elle est évaluée à true par défaut. Pour plus d’informations grammaticales, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpointNames

string[]

Liste des points de terminaison vers lesquels les messages qui satisfont à la condition sont routés. Actuellement, un seul point de terminaison est autorisé.

isEnabled

boolean

Permet de spécifier si un itinéraire est activé.

name

string

Nom de l'itinéraire. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union, une longueur maximale de 64 caractères et doit être unique.

source

RoutingSource

Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.

RoutingCosmosDBSqlApiProperties

Propriétés liées à un point de terminaison de conteneur sql cosmos DB.

Nom Type Description
authenticationType

authenticationType

Méthode utilisée pour l’authentification auprès du point de terminaison de conteneur sql cosmos DB

containerName

string

Nom du conteneur sql cosmos DB dans la base de données cosmos DB.

databaseName

string

Nom de la base de données cosmos DB dans le compte cosmos DB.

endpointUri

string

URL du compte Cosmos DB. Il doit inclure le protocole https://

id

string

ID du point de terminaison de conteneur sql cosmos DB

identity

ManagedIdentity

Propriétés d’identité managée du point de terminaison de conteneur cosmos DB de routage.

name

string

Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et a une longueur maximale de 64 caractères. Les noms suivants sont réservés : events, fileNotifications, $default. Les noms de point de terminaison doivent être uniques parmi les types de points de terminaison.

partitionKeyName

string

Nom de la clé de partition associée à ce conteneur sql cosmos DB s’il en existe un. Il s'agit d'un paramètre facultatif.

partitionKeyTemplate

string

Modèle permettant de générer une valeur de clé de partition synthétique à utiliser avec ce conteneur sql Cosmos DB. Le modèle doit inclure au moins un des espaces réservés suivants : {iothub}, {deviceid}, {DD}, {MM} et {AAAA}. N’importe quel espace réservé peut être spécifié au maximum une fois, mais l’ordre et les composants non réservés sont arbitraires. Ce paramètre n’est requis que si PartitionKeyName est spécifié.

primaryKey

string

Clé primaire du compte Cosmos DB.

resourceGroup

string

Nom du groupe de ressources du compte Cosmos DB.

secondaryKey

string

Clé secondaire du compte Cosmos DB.

subscriptionId

string

Identificateur d’abonnement du compte Cosmos DB.

RoutingEndpoints

Propriétés liées aux points de terminaison personnalisés vers lesquels votre hub IoT achemine les messages en fonction des règles de routage. Un maximum de 10 points de terminaison personnalisés sont autorisés pour tous les types de points de terminaison pour les hubs payants et un seul point de terminaison personnalisé est autorisé sur tous les types de points de terminaison pour les hubs gratuits.

Nom Type Description
cosmosDBSqlContainers

RoutingCosmosDBSqlApiProperties[]

Liste des points de terminaison de conteneur Cosmos DB auxquels IoT Hub achemine les messages, en fonction des règles de routage.

eventHubs

RoutingEventHubProperties[]

Liste des points de terminaison Event Hub auxquels IoT Hub achemine les messages, en fonction des règles de routage. Cette liste n’inclut pas le point de terminaison Event Hubs intégré.

serviceBusQueues

RoutingServiceBusQueueEndpointProperties[]

Liste des points de terminaison de file d’attente Service Bus auxquels IoT Hub achemine les messages, en fonction des règles de routage.

serviceBusTopics

RoutingServiceBusTopicEndpointProperties[]

Liste des points de terminaison de rubrique Service Bus auxquels l’IoT Hub achemine les messages, en fonction des règles de routage.

storageContainers

RoutingStorageContainerProperties[]

Liste des points de terminaison de conteneur de stockage auxquels IoT Hub achemine les messages, en fonction des règles de routage.

RoutingEventHubProperties

Propriétés liées à un point de terminaison de hub d’événements.

Nom Type Description
authenticationType

authenticationType

Méthode utilisée pour l’authentification auprès du point de terminaison du hub d’événements

connectionString

string

Chaîne de connexion du point de terminaison du hub d’événements.

endpointUri

string

URL du point de terminaison du hub d’événements. Il doit inclure le protocole sb://

entityPath

string

Nom du hub d’événements sur l’espace de noms du hub d’événements

id

string

ID du point de terminaison du hub d’événements

identity

ManagedIdentity

Propriétés d’identité managée du point de terminaison du hub d’événements de routage.

name

string

Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et a une longueur maximale de 64 caractères. Les noms suivants sont réservés : events, fileNotifications, $default. Les noms de point de terminaison doivent être uniques parmi les types de points de terminaison.

resourceGroup

string

Nom du groupe de ressources du point de terminaison du hub d’événements.

subscriptionId

string

Identificateur d’abonnement du point de terminaison du hub d’événements.

RoutingProperties

Propriétés liées au routage du hub IoT. Consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

Nom Type Description
endpoints

RoutingEndpoints

Propriétés liées aux points de terminaison personnalisés vers lesquels votre hub IoT achemine les messages en fonction des règles de routage. Un maximum de 10 points de terminaison personnalisés sont autorisés sur tous les types de points de terminaison pour les hubs payants et un seul point de terminaison personnalisé est autorisé sur tous les types de points de terminaison pour les hubs gratuits.

enrichments

EnrichmentProperties[]

Liste des enrichissements fournis par l’utilisateur que l’IoT Hub applique aux messages à remettre aux points de terminaison intégrés et personnalisés. Consultez : https://aka.ms/telemetryoneventgrid

fallbackRoute

FallbackRouteProperties

Propriétés de l’itinéraire utilisé comme itinéraire de secours lorsqu’aucune des conditions spécifiées dans la section « routes » n’est remplie. Il s'agit d'un paramètre facultatif. Lorsque cette propriété n’est pas présente dans le modèle, la route de secours est désactivée par défaut.

routes

RouteProperties[]

Liste des règles de routage fournies par l’utilisateur que le hub IoT utilise pour acheminer les messages vers des points de terminaison intégrés et personnalisés. Un maximum de 100 règles de routage sont autorisées pour les hubs payants et un maximum de 5 règles de routage sont autorisées pour les hubs gratuits.

RoutingServiceBusQueueEndpointProperties

Propriétés liées aux types de points de terminaison de file d’attente Service Bus.

Nom Type Description
authenticationType

authenticationType

Méthode utilisée pour s’authentifier auprès du point de terminaison de file d’attente Service Bus

connectionString

string

Chaîne de connexion du point de terminaison de file d’attente Service Bus.

endpointUri

string

URL du point de terminaison de file d’attente Service Bus. Il doit inclure le protocole sb://

entityPath

string

Nom de la file d’attente dans l’espace de noms Service Bus

id

string

ID du point de terminaison de file d’attente Service Bus

identity

ManagedIdentity

Propriétés d’identité managée du point de terminaison de file d’attente service bus de routage.

name

string

Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et a une longueur maximale de 64 caractères. Les noms suivants sont réservés : events, fileNotifications, $default. Les noms de point de terminaison doivent être uniques parmi les types de points de terminaison. Le nom n’a pas besoin d’être le même que le nom réel de la file d’attente.

resourceGroup

string

Nom du groupe de ressources du point de terminaison de file d’attente Service Bus.

subscriptionId

string

Identificateur d’abonnement du point de terminaison de file d’attente Service Bus.

RoutingServiceBusTopicEndpointProperties

Propriétés liées aux types de points de terminaison de rubrique Service Bus.

Nom Type Description
authenticationType

authenticationType

Méthode utilisée pour l’authentification auprès du point de terminaison de rubrique Service Bus

connectionString

string

Chaîne de connexion du point de terminaison de la rubrique Service Bus.

endpointUri

string

URL du point de terminaison de la rubrique Service Bus. Il doit inclure le protocole sb://

entityPath

string

Nom de la file d’attente sur la rubrique Service Bus

id

string

ID du point de terminaison de la rubrique Service Bus

identity

ManagedIdentity

Propriétés d’identité managée du point de terminaison de la rubrique Service Bus de routage.

name

string

Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et a une longueur maximale de 64 caractères. Les noms suivants sont réservés : events, fileNotifications, $default. Les noms de point de terminaison doivent être uniques parmi les types de points de terminaison. Le nom n’a pas besoin d’être le même que le nom réel de la rubrique.

resourceGroup

string

Nom du groupe de ressources du point de terminaison de rubrique Service Bus.

subscriptionId

string

Identificateur d’abonnement du point de terminaison de la rubrique Service Bus.

RoutingSource

Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.

Nom Type Description
DeviceConnectionStateEvents

string

DeviceJobLifecycleEvents

string

DeviceLifecycleEvents

string

DeviceMessages

string

Invalid

string

TwinChangeEvents

string

RoutingStorageContainerProperties

Propriétés liées à un point de terminaison de conteneur de stockage.

Nom Type Description
authenticationType

authenticationType

Méthode utilisée pour l’authentification auprès du point de terminaison de stockage

batchFrequencyInSeconds

integer

Intervalle de temps auquel les objets blob sont écrits dans le stockage. La valeur doit être comprise entre 60 et 720 secondes. La valeur par défaut est 300 secondes.

connectionString

string

Chaîne de connexion du compte de stockage.

containerName

string

Nom du conteneur de stockage dans le compte de stockage.

encoding enum:
  • Avro
  • AvroDeflate
  • JSON

Encodage utilisé pour sérialiser des messages dans des objets blob. Les valeurs prises en charge sont « avro », « avrodeflate » et « JSON ». La valeur par défaut est « avro ».

endpointUri

string

URL du point de terminaison de stockage. Il doit inclure le protocole https://

fileNameFormat

string

Format de nom de fichier pour l’objet blob. Le format par défaut est {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Tous les paramètres sont obligatoires, mais peuvent être réorganisés.

id

string

ID du point de terminaison du conteneur de stockage

identity

ManagedIdentity

Propriétés d’identité managée du point de terminaison de stockage de routage.

maxChunkSizeInBytes

integer

Nombre maximal d’octets pour chaque objet blob écrit dans le stockage. La valeur doit être comprise entre 10485760(10 Mo) et 524288000(500 Mo). La valeur par défaut est 314572800(300 Mo).

name

string

Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et a une longueur maximale de 64 caractères. Les noms suivants sont réservés : events, fileNotifications, $default. Les noms de point de terminaison doivent être uniques parmi les types de points de terminaison.

resourceGroup

string

Nom du groupe de ressources du compte de stockage.

subscriptionId

string

Identificateur d’abonnement du compte de stockage.

SharedAccessSignatureAuthorizationRule

Propriétés d’une stratégie d’accès partagé IoT Hub.

Nom Type Description
keyName

string

Nom de la stratégie d’accès partagé.

primaryKey

string

Clé primaire.

rights

AccessRights

Autorisations affectées à la stratégie d’accès partagé.

secondaryKey

string

Clé secondaire.

StorageEndpointProperties

Propriétés du point de terminaison stockage Azure pour le chargement de fichiers.

Nom Type Description
authenticationType

AuthenticationType

Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.

connectionString

string

Le chaîne de connexion pour le compte stockage Azure sur lequel les fichiers sont chargés.

containerName

string

Nom du conteneur racine dans lequel vous chargez des fichiers. Le conteneur n’a pas besoin d’exister, mais doit être créatable à l’aide de la connectionString spécifiée.

identity

ManagedIdentity

Propriétés d’identité managée du point de terminaison de stockage pour le chargement de fichiers.

sasTtlAsIso8601

string

Période pendant laquelle l’URI SAP généré par IoT Hub pour le chargement de fichiers est valide. Voir https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.