Microsoft.Devices IotHubs

• dernière
• 2023-06-30
• 2023-06-30-preview
• 2022-11-15-preview
• 2022-04-30-preview
• 2021-07-02
• 2021-07-02-preview
• 2021-07-01
• 2021-07-01-preview
• 2021-03-31
• 2021-03-03-preview
• 2021-02-01-preview
• 2020-08-31
• 2020-08-31-preview
• 2020-08-01
• 2020-07-10-preview
• 2020-06-15
• 2020-04-01
• 2020-03-01
• 2019-11-04
• 2019-07-01-preview
• 2019-03-22
• 2019-03-22-preview
• 2018-12-01-preview
• 2018-04-01
• 2018-01-22
• 2017-07-01
• 2017-01-19
• 2016-02-03

Définition de ressource Bicep

Le type de ressource IotHubs peut être déployé avec des opérations qui ciblent :

• groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Devices/IotHubs, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Devices/IotHubs@2023-06-30' = {
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    allowedFqdnList: [
      'string'
    ]
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    cloudToDevice: {
      defaultTtlAsIso8601: 'string'
      feedback: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
      maxDeliveryCount: int
    }
    comments: 'string'
    disableDeviceSAS: bool
    disableLocalAuth: bool
    disableModuleSAS: bool
    enableDataResidency: bool
    enableFileUploadNotifications: bool
    eventHubEndpoints: {
      {customized property}: {
        partitionCount: int
        retentionTimeInDays: int
      }
    }
    features: 'string'
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
      }
    ]
    messagingEndpoints: {
      {customized property}: {
        lockDurationAsIso8601: 'string'
        maxDeliveryCount: int
        ttlAsIso8601: 'string'
      }
    }
    minTlsVersion: 'string'
    networkRuleSets: {
      applyToBuiltInEventHubEndpoint: bool
      defaultAction: 'string'
      ipRules: [
        {
          action: 'string'
          filterName: 'string'
          ipMask: 'string'
        }
      ]
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    restrictOutboundNetworkAccess: bool
    routing: {
      endpoints: {
        cosmosDBSqlContainers: [
          {
            authenticationType: 'string'
            containerName: 'string'
            databaseName: 'string'
            endpointUri: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            partitionKeyName: 'string'
            partitionKeyTemplate: 'string'
            primaryKey: 'string'
            resourceGroup: 'string'
            secondaryKey: 'string'
            subscriptionId: 'string'
          }
        ]
        eventHubs: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusQueues: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        serviceBusTopics: [
          {
            authenticationType: 'string'
            connectionString: 'string'
            endpointUri: 'string'
            entityPath: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
        storageContainers: [
          {
            authenticationType: 'string'
            batchFrequencyInSeconds: int
            connectionString: 'string'
            containerName: 'string'
            encoding: 'string'
            endpointUri: 'string'
            fileNameFormat: 'string'
            id: 'string'
            identity: {
              userAssignedIdentity: 'string'
            }
            maxChunkSizeInBytes: int
            name: 'string'
            resourceGroup: 'string'
            subscriptionId: 'string'
          }
        ]
      }
      enrichments: [
        {
          endpointNames: [
            'string'
          ]
          key: 'string'
          value: 'string'
        }
      ]
      fallbackRoute: {
        condition: 'string'
        endpointNames: [
          'string'
        ]
        isEnabled: bool
        name: 'string'
        source: 'string'
      }
      routes: [
        {
          condition: 'string'
          endpointNames: [
            'string'
          ]
          isEnabled: bool
          name: 'string'
          source: 'string'
        }
      ]
    }
    storageEndpoints: {
      {customized property}: {
        authenticationType: 'string'
        connectionString: 'string'
        containerName: 'string'
        identity: {
          userAssignedIdentity: 'string'
        }
        sasTtlAsIso8601: 'string'
      }
    }
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

ArmIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Dictionnaire de <> ArmUserIdentity	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nom	Description	Valeur

ArmUserIdentity

Nom	Description	Valeur

CloudToDeviceProperties

Nom	Description	Valeur
defaultTtlAsIso8601	Heure par défaut de vie des messages cloud-à-appareil dans la file d’attente de l’appareil. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	corde
rétroaction	Propriétés de la file d’attente de commentaires pour les messages cloud-à-appareil.	FeedbackProperties
maxDeliveryCount	Nombre maximal de remises pour les messages cloud-à-appareil dans la file d’attente de l’appareil. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 100

EnrichmentProperties

Nom	Description	Valeur
endpointNames	Liste des points de terminaison pour lesquels l’enrichissement est appliqué au message.	string[] (obligatoire)
clé	Clé ou nom de la propriété d’enrichissement.	chaîne (obligatoire)
valeur	Valeur de la propriété d’enrichissement.	chaîne (obligatoire)

EventHubProperties

Nom	Description	Valeur
partitionCount	Nombre de partitions pour la réception de messages appareil-à-cloud dans le point de terminaison compatible Event Hub. Voir : /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	Int
retentionTimeInDays	Durée de rétention des messages appareil-à-cloud en jours. Voir : /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	Int

FallbackRouteProperties

Nom	Description	Valeur
condition	Condition évaluée pour appliquer l’itinéraire de secours. Si la condition n’est pas fournie, elle prend la valeur true par défaut. Pour la grammaire, consultez : /azure/iot-hub/iot-hub-devguide-query-language	corde
endpointNames	Liste des points de terminaison vers lesquels les messages qui répondent à la condition sont routés. Actuellement, seul 1 point de terminaison est autorisé.	string[] (obligatoire)
isEnabled	Permet de spécifier si l’itinéraire de secours est activé.	bool (obligatoire)
nom	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.	corde
source	Source à laquelle la règle de routage doit être appliquée. Par exemple, DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Invalid' 'TwinChangeEvents' (obligatoire)

FeedbackProperties

Nom	Description	Valeur
lockDurationAsIso8601	Durée de verrouillage de la file d’attente de commentaires. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	corde
maxDeliveryCount	Nombre de tentatives de remise d’un message sur la file d’attente de commentaires par le hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 100
ttlAsIso8601	Période pendant laquelle un message est disponible pour être consommé avant son expiration par le hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	corde

IotHubProperties

Nom	Description	Valeur
allowedFqdnList	Liste des noms de domaine complets autorisés (nom de domaine complet) pour la sortie à partir d’Iot Hub.	string[]
authorizationPolicies	Les stratégies d’accès partagé que vous pouvez utiliser pour sécuriser une connexion au hub IoT.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	Propriétés de messagerie cloud-à-appareil ioT Hub.	CloudToDeviceProperties
Commentaires	Commentaires ioT Hub.	corde
disableDeviceSAS	Si la valeur est true, tous les appareils (y compris les appareils Edge, mais à l’exclusion des modules) ne peuvent pas être utilisés pour l’authentification.	Bool
disableLocalAuth	Si la valeur est true, les jetons SAP avec des clés SAP étendues Iot hub ne peuvent pas être utilisés pour l’authentification.	Bool
disableModuleSAS	Si la valeur est true, toutes les clés SAP étendues au module ne peuvent pas être utilisées pour l’authentification.	Bool
enableDataResidency	Cette propriété lorsqu’elle est définie sur true active la résidence des données, ce qui désactive la récupération d’urgence.	Bool
enableFileUploadNotifications	Si la valeur est True, les notifications de chargement de fichiers sont activées.	Bool
eventHubEndpoints	Propriétés de point de terminaison compatibles avec Event Hub. La seule clé possible pour ce dictionnaire est les événements. Cette clé doit être présente dans le dictionnaire tout en effectuant des appels de création ou de mise à jour pour le hub IoT.	IotHubPropertiesEventHubEndpoints
fonctionnalités	Fonctionnalités et fonctionnalités activées pour le hub IoT.	'DeviceManagement' 'None'
ipFilterRules	Règles de filtre IP.	IpFilterRule []
messagingEndpoints	Propriétés du point de terminaison de messagerie pour la file d’attente de notification de chargement de fichier.	IotHubPropertiesMessagingEndpoints
minTlsVersion	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 à la version 1.2 soient rejetés.	corde
networkRuleSets	Propriétés de l’ensemble de règles réseau d’IotHub	NetworkRuleSetProperties
privateEndpointConnections	Connexions de point de terminaison privé créées sur cet IotHub	PrivateEndpointConnection[]
publicNetworkAccess	Indique si les demandes du réseau public sont autorisées	'Désactivé' 'Activé'
restrictOutboundNetworkAccess	Si la valeur est true, la sortie d’IotHub est limitée uniquement aux noms de domaine complets autorisés configurés via allowedFqdnList.	Bool
routage	Propriétés associées au routage du hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	Liste des points de terminaison stockage Azure où vous pouvez charger des fichiers. Actuellement, vous ne pouvez configurer qu’un seul compte stockage Azure et qui doit avoir sa clé comme $default. La spécification de plusieurs comptes de stockage provoque 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 générée.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Nom	Description	Valeur

IotHubPropertiesMessagingEndpoints

Nom	Description	Valeur

IotHubPropertiesStorageEndpoints

Nom	Description	Valeur

IotHubSkuInfo

Nom	Description	Valeur
capacité	Nombre d’unités IoT Hub approvisionnées. Consultez : /azure/azure-subscription-service-limits#iot-hub-limits.	Int
nom	Nom de la référence SKU.	'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (obligatoire)

IpFilterRule

Nom	Description	Valeur
action	Action souhaitée pour les demandes capturées par cette règle.	'Accepter' 'Reject' (obligatoire)
filterName	Nom de la règle de filtre IP.	chaîne (obligatoire)
ipMask	Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.	chaîne (obligatoire)

ManagedIdentity

Nom	Description	Valeur
userAssignedIdentity	Identité affectée par l’utilisateur.	corde

MessagingEndpointProperties

Nom	Description	Valeur
lockDurationAsIso8601	Durée du verrou. Voir : /azure/iot-hub/iot-hub-devguide-file-upload.	corde
maxDeliveryCount	Nombre de tentatives de remise d’un message par le hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-file-upload.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 100
ttlAsIso8601	Période pendant laquelle un message est disponible pour être consommé avant son expiration par le hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-file-upload.	corde

Microsoft.Devices/IotHubs

Nom	Description	Valeur
etag	Le champ Etag n’est pas requis. S’il est fourni dans le corps de la réponse, il doit également être fourni en tant qu’en-tête conformément à la convention ETag normale.	corde
identité	Identités managées pour IotHub.	ArmIdentity
emplacement	Emplacement de la ressource.	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés IotHub	IotHubProperties
Sku	Informations sur la référence SKU IotHub	IotHubSkuInfo (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

NetworkRuleSetIpRule

Nom	Description	Valeur
action	Action de filtre IP	'Autoriser'
filterName	Nom de la règle de filtre IP.	chaîne (obligatoire)
ipMask	Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.	chaîne (obligatoire)

NetworkRuleSetProperties

Nom	Description	Valeur
applyToBuiltInEventHubEndpoint	Si la valeur est True, l’ensemble de règles réseau est également appliqué à BuiltIn EventHub EndPoint d’IotHub	bool (obligatoire)
defaultAction	Action par défaut pour l’ensemble de règles réseau	'Autoriser' 'Refuser'
ipRules	Liste des règles IP	NetworkRuleSetIpRule[] (obligatoire)

PrivateEndpoint

Nom	Description	Valeur

PrivateEndpointConnection

Nom	Description	Valeur
Propriétés	Propriétés d’une connexion de point de terminaison privé	PrivateEndpointConnectionProperties (obligatoire)

PrivateEndpointConnectionProperties

Nom	Description	Valeur
privateEndpoint	Propriété de point de terminaison privé d’une connexion de point de terminaison privé	PrivateEndpoint
privateLinkServiceConnectionState	État actuel d’une connexion de point de terminaison privé	PrivateLinkServiceConnectionState (obligatoire)

PrivateLinkServiceConnectionState

Nom	Description	Valeur
actionsRequired	Actions requises pour une connexion de point de terminaison privé	corde
description	Description de l’état actuel d’une connexion de point de terminaison privé	chaîne (obligatoire)
statut	État d’une connexion de point de terminaison privé	'Approuvé' 'Déconnecté' 'En attente' 'Rejeté' (obligatoire)

ResourceTags

Nom	Description	Valeur

RouteProperties

Nom	Description	Valeur
condition	Condition évaluée pour appliquer la règle de routage. Si aucune condition n’est fournie, elle prend la valeur true par défaut. Pour la grammaire, consultez : /azure/iot-hub/iot-hub-devguide-query-language	corde
endpointNames	Liste des points de terminaison vers lesquels les messages qui répondent à la condition sont routés. Actuellement, un seul point de terminaison est autorisé.	string[] (obligatoire)
isEnabled	Permet de spécifier si un itinéraire est activé.	bool (obligatoire)
nom	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.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
source	Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Invalid' 'TwinChangeEvents' (obligatoire)

RoutingCosmosDBSqlApiProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de conteneur sql cosmos DB	'identityBased' 'keyBased'
containerName	Nom du conteneur sql cosmos DB dans la base de données Cosmos DB.	chaîne (obligatoire)
databaseName	Nom de la base de données cosmos DB dans le compte cosmos DB.	chaîne (obligatoire)
endpointUri	URL du compte cosmos DB. Il doit inclure le protocole https://	chaîne (obligatoire)
identité	Propriétés d’identité managée du point de terminaison de conteneur cosmos DB de routage.	managedIdentity
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
partitionKeyName	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.	corde
partitionKeyTemplate	Modèle de génération d’une valeur de clé de partition synthétique à utiliser avec ce conteneur sql cosmos DB. Le modèle doit inclure au moins l’un des espaces réservés suivants : {iothub}, {deviceid}, {DD}, {MM}et {AAAA}. Tous les espaces réservés peuvent être spécifiés au maximum une fois, mais les composants de commande et non-espace réservé sont arbitraires. Ce paramètre est obligatoire uniquement si PartitionKeyName est spécifié.	corde
primaryKey	Clé primaire du compte Cosmos DB.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
resourceGroup	Nom du groupe de ressources du compte cosmos DB.	corde
secondaryKey	Clé secondaire du compte Cosmos DB.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
subscriptionId	Identificateur d’abonnement du compte Cosmos DB.	corde

RoutingEndpoints

Nom	Description	Valeur
cosmosDBSqlContainers	La liste des points de terminaison de conteneur Cosmos DB vers utilisant IoT Hub achemine les messages en fonction des règles de routage.	RoutingCosmosDBSqlApiProperties[]
eventHubs	Liste des points de terminaison Event Hubs 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é.	RoutingEventHubProperties[]
serviceBusQueues	Liste des points de terminaison de file d’attente Service Bus auxquels IoT Hub achemine les messages en fonction des règles de routage.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	Liste des points de terminaison de rubrique Service Bus auxquels le hub IoT achemine les messages en fonction des règles de routage.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	Liste des points de terminaison de conteneur de stockage vers utilisant ioT Hub qui acheminent les messages en fonction des règles de routage.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison event Hub	'identityBased' 'keyBased'
connectionString	Chaîne de connexion du point de terminaison event Hub.	corde
endpointUri	URL du point de terminaison event Hub. Il doit inclure le protocole sb://	corde
entityPath	Nom du hub d’événements sur l’espace de noms du hub d’événements	corde
id	ID du point de terminaison du hub d’événements	corde
identité	Propriétés d’identité managée du point de terminaison event Hub de routage.	managedIdentity
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
resourceGroup	Nom du groupe de ressources du point de terminaison event Hub.	corde
subscriptionId	Identificateur d’abonnement du point de terminaison event Hub.	corde

RoutingProperties

Nom	Description	Valeur
Terminaison	Propriétés liées aux points de terminaison personnalisés auxquels 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.	RoutingEndpoints
enrichissements	Liste des enrichissements fournis par l’utilisateur que le hub IoT s’applique aux messages à remettre aux points de terminaison intégrés et personnalisés. Voir : https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	Propriétés de l’itinéraire utilisé comme itinéraire de secours quand 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, l’itinéraire de secours est désactivé par défaut.	FallbackRouteProperties
itinéraires	Liste des règles de routage fournies par l’utilisateur que le hub IoT utilise pour router 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.	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de file d’attente Service Bus	'identityBased' 'keyBased'
connectionString	Chaîne de connexion du point de terminaison de file d’attente Service Bus.	corde
endpointUri	URL du point de terminaison de file d’attente Service Bus. Il doit inclure le protocole sb://	corde
entityPath	Nom de la file d’attente sur l’espace de noms Service Bus	corde
id	ID du point de terminaison de file d’attente Service Bus	corde
identité	Propriétés d’identité managée du point de terminaison de file d’attente service bus de routage.	managedIdentity
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison. Le nom n’a pas besoin d’être identique au nom de file d’attente réel.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
resourceGroup	Nom du groupe de ressources du point de terminaison de file d’attente Service Bus.	corde
subscriptionId	Identificateur d’abonnement du point de terminaison de file d’attente Service Bus.	corde

RoutingServiceBusTopicEndpointProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de rubrique Service Bus	'identityBased' 'keyBased'
connectionString	Chaîne de connexion du point de terminaison de rubrique Service Bus.	corde
endpointUri	URL du point de terminaison de rubrique Service Bus. Il doit inclure le protocole sb://	corde
entityPath	Nom de la file d’attente dans la rubrique Service Bus	corde
id	ID du point de terminaison de rubrique Service Bus	corde
identité	Propriétés d’identité managée du point de terminaison de rubrique Service Bus de routage.	managedIdentity
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison. Le nom n’a pas besoin d’être identique au nom de la rubrique réelle.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
resourceGroup	Nom du groupe de ressources du point de terminaison de rubrique Service Bus.	corde
subscriptionId	Identificateur d’abonnement du point de terminaison de rubrique Service Bus.	corde

RoutingStorageContainerProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de stockage	'identityBased' 'keyBased'
batchFrequencyInSeconds	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 de 300 secondes.	Int Contraintes: Valeur minimale = 60 Valeur maximale = 720
connectionString	Chaîne de connexion du compte de stockage.	corde
containerName	Nom du conteneur de stockage dans le compte de stockage.	chaîne (obligatoire)
codage	Encodage utilisé pour sérialiser les messages vers des objets blob. Les valeurs prises en charge sont « avro », « avrodeflate » et « JSON ». La valeur par défaut est « avro ».	'Avro' 'AvroDeflate' 'JSON'
endpointUri	URL du point de terminaison de stockage. Il doit inclure le protocole https://	corde
fileNameFormat	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é.	corde
id	ID du point de terminaison du conteneur de stockage	corde
identité	Propriétés d’identité managée du point de terminaison de stockage de routage.	managedIdentity
maxChunkSizeInBytes	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).	Int Contraintes: Valeur minimale = 10485760 Valeur maximale = 524288000
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
resourceGroup	Nom du groupe de ressources du compte de stockage.	corde
subscriptionId	Identificateur d’abonnement du compte de stockage.	corde

SharedAccessSignatureAuthorizationRule

Nom	Description	Valeur
keyName	Nom de la stratégie d’accès partagé.	chaîne (obligatoire)
primaryKey	Clé primaire.	corde
droits	Autorisations affectées à la stratégie d’accès partagé.	'DeviceConnect' 'RegistryRead' 'RegistryRead, DeviceConnect' 'RegistryRead, RegistryWrite' 'RegistryRead, RegistryWrite, DeviceConnect' 'RegistryRead, RegistryWrite, ServiceConnect' « RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect » 'RegistryRead, ServiceConnect' ' RegistryRead, ServiceConnect, DeviceConnect' 'RegistryWrite' 'RegistryWrite, DeviceConnect' 'RegistryWrite, ServiceConnect' 'RegistryWrite, ServiceConnect, DeviceConnect' 'ServiceConnect' 'ServiceConnect, DeviceConnect' (obligatoire)
secondaryKey	Clé secondaire.	corde

StorageEndpointProperties

Nom	Description	Valeur
authenticationType	Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.	'identityBased' 'keyBased'
connectionString	Chaîne de connexion pour le compte stockage Azure vers lequel les fichiers sont chargés.	chaîne (obligatoire)
containerName	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 connectionString spécifié.	chaîne (obligatoire)
identité	Propriétés d’identité managée du point de terminaison de stockage pour le chargement de fichiers.	managedIdentity
sasTtlAsIso8601	Période pendant laquelle l’URI SAP généré par IoT Hub pour le chargement de fichiers est valide. Voir : /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	corde

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep	Description
créer un hub IoT et un groupe de consommateurs d’appareils vers le cloud	Ce modèle vous permet de déployer une instance IoT Hub avec un appareil vers le cloud et le cloud vers des configurations de messagerie d’appareil et un appareil dans un groupe de consommateurs cloud.
créer un service IoT Hub Device Provisioning	Ce modèle vous permet de créer un hub IoT et un service IoT Hub Device Provisioning et de lier les deux services.
Créer une mise à jour d’appareil pour un compte IoT Hub, une instance, un IoT Hub	Ce modèle crée un compte, une instance et un hub pour lier l’instance. Il configure le hub avec les stratégies d’accès, les itinéraires et le groupe de consommateurs nécessaires.
déployer le service MedTech, y compris un Azure IoT Hub	Le service MedTech est l’un des services de données Azure Health conçus pour ingérer des données d’appareil à partir de plusieurs appareils, transformer les données d’appareil en observations FHIR, qui sont ensuite conservées dans le service FHIR Azure Health Data Services.
Utiliser un modèle ARM pour créer IoT Hub, acheminer et afficher des messages	Utilisez ce modèle pour déployer un hub IoT et un compte de stockage. Exécutez une application pour envoyer des messages au hub routés vers le stockage, puis affichez les résultats.

Définition de ressource de modèle ARM

Le type de ressource IotHubs peut être déployé avec des opérations qui ciblent :

• groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Devices/IotHubs, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2023-06-30",
  "name": "string",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "allowedFqdnList": [ "string" ],
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "cloudToDevice": {
      "defaultTtlAsIso8601": "string",
      "feedback": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      },
      "maxDeliveryCount": "int"
    },
    "comments": "string",
    "disableDeviceSAS": "bool",
    "disableLocalAuth": "bool",
    "disableModuleSAS": "bool",
    "enableDataResidency": "bool",
    "enableFileUploadNotifications": "bool",
    "eventHubEndpoints": {
      "{customized property}": {
        "partitionCount": "int",
        "retentionTimeInDays": "int"
      }
    },
    "features": "string",
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string"
      }
    ],
    "messagingEndpoints": {
      "{customized property}": {
        "lockDurationAsIso8601": "string",
        "maxDeliveryCount": "int",
        "ttlAsIso8601": "string"
      }
    },
    "minTlsVersion": "string",
    "networkRuleSets": {
      "applyToBuiltInEventHubEndpoint": "bool",
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "string",
          "filterName": "string",
          "ipMask": "string"
        }
      ]
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "restrictOutboundNetworkAccess": "bool",
    "routing": {
      "endpoints": {
        "cosmosDBSqlContainers": [
          {
            "authenticationType": "string",
            "containerName": "string",
            "databaseName": "string",
            "endpointUri": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "partitionKeyName": "string",
            "partitionKeyTemplate": "string",
            "primaryKey": "string",
            "resourceGroup": "string",
            "secondaryKey": "string",
            "subscriptionId": "string"
          }
        ],
        "eventHubs": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusQueues": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "serviceBusTopics": [
          {
            "authenticationType": "string",
            "connectionString": "string",
            "endpointUri": "string",
            "entityPath": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ],
        "storageContainers": [
          {
            "authenticationType": "string",
            "batchFrequencyInSeconds": "int",
            "connectionString": "string",
            "containerName": "string",
            "encoding": "string",
            "endpointUri": "string",
            "fileNameFormat": "string",
            "id": "string",
            "identity": {
              "userAssignedIdentity": "string"
            },
            "maxChunkSizeInBytes": "int",
            "name": "string",
            "resourceGroup": "string",
            "subscriptionId": "string"
          }
        ]
      },
      "enrichments": [
        {
          "endpointNames": [ "string" ],
          "key": "string",
          "value": "string"
        }
      ],
      "fallbackRoute": {
        "condition": "string",
        "endpointNames": [ "string" ],
        "isEnabled": "bool",
        "name": "string",
        "source": "string"
      },
      "routes": [
        {
          "condition": "string",
          "endpointNames": [ "string" ],
          "isEnabled": "bool",
          "name": "string",
          "source": "string"
        }
      ]
    },
    "storageEndpoints": {
      "{customized property}": {
        "authenticationType": "string",
        "connectionString": "string",
        "containerName": "string",
        "identity": {
          "userAssignedIdentity": "string"
        },
        "sasTtlAsIso8601": "string"
      }
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

ArmIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Dictionnaire de <> ArmUserIdentity	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nom	Description	Valeur

ArmUserIdentity

Nom	Description	Valeur

CloudToDeviceProperties

Nom	Description	Valeur
defaultTtlAsIso8601	Heure par défaut de vie des messages cloud-à-appareil dans la file d’attente de l’appareil. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	corde
rétroaction	Propriétés de la file d’attente de commentaires pour les messages cloud-à-appareil.	FeedbackProperties
maxDeliveryCount	Nombre maximal de remises pour les messages cloud-à-appareil dans la file d’attente de l’appareil. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 100

EnrichmentProperties

Nom	Description	Valeur
endpointNames	Liste des points de terminaison pour lesquels l’enrichissement est appliqué au message.	string[] (obligatoire)
clé	Clé ou nom de la propriété d’enrichissement.	chaîne (obligatoire)
valeur	Valeur de la propriété d’enrichissement.	chaîne (obligatoire)

EventHubProperties

Nom	Description	Valeur
partitionCount	Nombre de partitions pour la réception de messages appareil-à-cloud dans le point de terminaison compatible Event Hub. Voir : /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	Int
retentionTimeInDays	Durée de rétention des messages appareil-à-cloud en jours. Voir : /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	Int

FallbackRouteProperties

Nom	Description	Valeur
condition	Condition évaluée pour appliquer l’itinéraire de secours. Si la condition n’est pas fournie, elle prend la valeur true par défaut. Pour la grammaire, consultez : /azure/iot-hub/iot-hub-devguide-query-language	corde
endpointNames	Liste des points de terminaison vers lesquels les messages qui répondent à la condition sont routés. Actuellement, seul 1 point de terminaison est autorisé.	string[] (obligatoire)
isEnabled	Permet de spécifier si l’itinéraire de secours est activé.	bool (obligatoire)
nom	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.	corde
source	Source à laquelle la règle de routage doit être appliquée. Par exemple, DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Invalid' 'TwinChangeEvents' (obligatoire)

FeedbackProperties

Nom	Description	Valeur
lockDurationAsIso8601	Durée de verrouillage de la file d’attente de commentaires. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	corde
maxDeliveryCount	Nombre de tentatives de remise d’un message sur la file d’attente de commentaires par le hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 100
ttlAsIso8601	Période pendant laquelle un message est disponible pour être consommé avant son expiration par le hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	corde

IotHubProperties

Nom	Description	Valeur
allowedFqdnList	Liste des noms de domaine complets autorisés (nom de domaine complet) pour la sortie à partir d’Iot Hub.	string[]
authorizationPolicies	Les stratégies d’accès partagé que vous pouvez utiliser pour sécuriser une connexion au hub IoT.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	Propriétés de messagerie cloud-à-appareil ioT Hub.	CloudToDeviceProperties
Commentaires	Commentaires ioT Hub.	corde
disableDeviceSAS	Si la valeur est true, tous les appareils (y compris les appareils Edge, mais à l’exclusion des modules) ne peuvent pas être utilisés pour l’authentification.	Bool
disableLocalAuth	Si la valeur est true, les jetons SAP avec des clés SAP étendues Iot hub ne peuvent pas être utilisés pour l’authentification.	Bool
disableModuleSAS	Si la valeur est true, toutes les clés SAP étendues au module ne peuvent pas être utilisées pour l’authentification.	Bool
enableDataResidency	Cette propriété lorsqu’elle est définie sur true active la résidence des données, ce qui désactive la récupération d’urgence.	Bool
enableFileUploadNotifications	Si la valeur est True, les notifications de chargement de fichiers sont activées.	Bool
eventHubEndpoints	Propriétés de point de terminaison compatibles avec Event Hub. La seule clé possible pour ce dictionnaire est les événements. Cette clé doit être présente dans le dictionnaire tout en effectuant des appels de création ou de mise à jour pour le hub IoT.	IotHubPropertiesEventHubEndpoints
fonctionnalités	Fonctionnalités et fonctionnalités activées pour le hub IoT.	'DeviceManagement' 'None'
ipFilterRules	Règles de filtre IP.	IpFilterRule []
messagingEndpoints	Propriétés du point de terminaison de messagerie pour la file d’attente de notification de chargement de fichier.	IotHubPropertiesMessagingEndpoints
minTlsVersion	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 à la version 1.2 soient rejetés.	corde
networkRuleSets	Propriétés de l’ensemble de règles réseau d’IotHub	NetworkRuleSetProperties
privateEndpointConnections	Connexions de point de terminaison privé créées sur cet IotHub	PrivateEndpointConnection[]
publicNetworkAccess	Indique si les demandes du réseau public sont autorisées	'Désactivé' 'Activé'
restrictOutboundNetworkAccess	Si la valeur est true, la sortie d’IotHub est limitée uniquement aux noms de domaine complets autorisés configurés via allowedFqdnList.	Bool
routage	Propriétés associées au routage du hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	Liste des points de terminaison stockage Azure où vous pouvez charger des fichiers. Actuellement, vous ne pouvez configurer qu’un seul compte stockage Azure et qui doit avoir sa clé comme $default. La spécification de plusieurs comptes de stockage provoque 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 générée.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Nom	Description	Valeur

IotHubPropertiesMessagingEndpoints

Nom	Description	Valeur

IotHubPropertiesStorageEndpoints

Nom	Description	Valeur

IotHubSkuInfo

Nom	Description	Valeur
capacité	Nombre d’unités IoT Hub approvisionnées. Consultez : /azure/azure-subscription-service-limits#iot-hub-limits.	Int
nom	Nom de la référence SKU.	'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (obligatoire)

IpFilterRule

Nom	Description	Valeur
action	Action souhaitée pour les demandes capturées par cette règle.	'Accepter' 'Reject' (obligatoire)
filterName	Nom de la règle de filtre IP.	chaîne (obligatoire)
ipMask	Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.	chaîne (obligatoire)

ManagedIdentity

Nom	Description	Valeur
userAssignedIdentity	Identité affectée par l’utilisateur.	corde

MessagingEndpointProperties

Nom	Description	Valeur
lockDurationAsIso8601	Durée du verrou. Voir : /azure/iot-hub/iot-hub-devguide-file-upload.	corde
maxDeliveryCount	Nombre de tentatives de remise d’un message par le hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-file-upload.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 100
ttlAsIso8601	Période pendant laquelle un message est disponible pour être consommé avant son expiration par le hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-file-upload.	corde

Microsoft.Devices/IotHubs

Nom	Description	Valeur
apiVersion	Version de l’API	'2023-06-30'
etag	Le champ Etag n’est pas requis. S’il est fourni dans le corps de la réponse, il doit également être fourni en tant qu’en-tête conformément à la convention ETag normale.	corde
identité	Identités managées pour IotHub.	ArmIdentity
emplacement	Emplacement de la ressource.	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés IotHub	IotHubProperties
Sku	Informations sur la référence SKU IotHub	IotHubSkuInfo (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type	Type de ressource	'Microsoft.Devices/IotHubs'

NetworkRuleSetIpRule

Nom	Description	Valeur
action	Action de filtre IP	'Autoriser'
filterName	Nom de la règle de filtre IP.	chaîne (obligatoire)
ipMask	Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.	chaîne (obligatoire)

NetworkRuleSetProperties

Nom	Description	Valeur
applyToBuiltInEventHubEndpoint	Si la valeur est True, l’ensemble de règles réseau est également appliqué à BuiltIn EventHub EndPoint d’IotHub	bool (obligatoire)
defaultAction	Action par défaut pour l’ensemble de règles réseau	'Autoriser' 'Refuser'
ipRules	Liste des règles IP	NetworkRuleSetIpRule[] (obligatoire)

PrivateEndpoint

Nom	Description	Valeur

PrivateEndpointConnection

Nom	Description	Valeur
Propriétés	Propriétés d’une connexion de point de terminaison privé	PrivateEndpointConnectionProperties (obligatoire)

PrivateEndpointConnectionProperties

Nom	Description	Valeur
privateEndpoint	Propriété de point de terminaison privé d’une connexion de point de terminaison privé	PrivateEndpoint
privateLinkServiceConnectionState	État actuel d’une connexion de point de terminaison privé	PrivateLinkServiceConnectionState (obligatoire)

PrivateLinkServiceConnectionState

Nom	Description	Valeur
actionsRequired	Actions requises pour une connexion de point de terminaison privé	corde
description	Description de l’état actuel d’une connexion de point de terminaison privé	chaîne (obligatoire)
statut	État d’une connexion de point de terminaison privé	'Approuvé' 'Déconnecté' 'En attente' 'Rejeté' (obligatoire)

ResourceTags

Nom	Description	Valeur

RouteProperties

Nom	Description	Valeur
condition	Condition évaluée pour appliquer la règle de routage. Si aucune condition n’est fournie, elle prend la valeur true par défaut. Pour la grammaire, consultez : /azure/iot-hub/iot-hub-devguide-query-language	corde
endpointNames	Liste des points de terminaison vers lesquels les messages qui répondent à la condition sont routés. Actuellement, un seul point de terminaison est autorisé.	string[] (obligatoire)
isEnabled	Permet de spécifier si un itinéraire est activé.	bool (obligatoire)
nom	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.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
source	Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Invalid' 'TwinChangeEvents' (obligatoire)

RoutingCosmosDBSqlApiProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de conteneur sql cosmos DB	'identityBased' 'keyBased'
containerName	Nom du conteneur sql cosmos DB dans la base de données Cosmos DB.	chaîne (obligatoire)
databaseName	Nom de la base de données cosmos DB dans le compte cosmos DB.	chaîne (obligatoire)
endpointUri	URL du compte cosmos DB. Il doit inclure le protocole https://	chaîne (obligatoire)
identité	Propriétés d’identité managée du point de terminaison de conteneur cosmos DB de routage.	managedIdentity
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
partitionKeyName	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.	corde
partitionKeyTemplate	Modèle de génération d’une valeur de clé de partition synthétique à utiliser avec ce conteneur sql cosmos DB. Le modèle doit inclure au moins l’un des espaces réservés suivants : {iothub}, {deviceid}, {DD}, {MM}et {AAAA}. Tous les espaces réservés peuvent être spécifiés au maximum une fois, mais les composants de commande et non-espace réservé sont arbitraires. Ce paramètre est obligatoire uniquement si PartitionKeyName est spécifié.	corde
primaryKey	Clé primaire du compte Cosmos DB.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
resourceGroup	Nom du groupe de ressources du compte cosmos DB.	corde
secondaryKey	Clé secondaire du compte Cosmos DB.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
subscriptionId	Identificateur d’abonnement du compte Cosmos DB.	corde

RoutingEndpoints

Nom	Description	Valeur
cosmosDBSqlContainers	La liste des points de terminaison de conteneur Cosmos DB vers utilisant IoT Hub achemine les messages en fonction des règles de routage.	RoutingCosmosDBSqlApiProperties[]
eventHubs	Liste des points de terminaison Event Hubs 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é.	RoutingEventHubProperties[]
serviceBusQueues	Liste des points de terminaison de file d’attente Service Bus auxquels IoT Hub achemine les messages en fonction des règles de routage.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	Liste des points de terminaison de rubrique Service Bus auxquels le hub IoT achemine les messages en fonction des règles de routage.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	Liste des points de terminaison de conteneur de stockage vers utilisant ioT Hub qui acheminent les messages en fonction des règles de routage.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison event Hub	'identityBased' 'keyBased'
connectionString	Chaîne de connexion du point de terminaison event Hub.	corde
endpointUri	URL du point de terminaison event Hub. Il doit inclure le protocole sb://	corde
entityPath	Nom du hub d’événements sur l’espace de noms du hub d’événements	corde
id	ID du point de terminaison du hub d’événements	corde
identité	Propriétés d’identité managée du point de terminaison event Hub de routage.	managedIdentity
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
resourceGroup	Nom du groupe de ressources du point de terminaison event Hub.	corde
subscriptionId	Identificateur d’abonnement du point de terminaison event Hub.	corde

RoutingProperties

Nom	Description	Valeur
Terminaison	Propriétés liées aux points de terminaison personnalisés auxquels 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.	RoutingEndpoints
enrichissements	Liste des enrichissements fournis par l’utilisateur que le hub IoT s’applique aux messages à remettre aux points de terminaison intégrés et personnalisés. Voir : https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	Propriétés de l’itinéraire utilisé comme itinéraire de secours quand 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, l’itinéraire de secours est désactivé par défaut.	FallbackRouteProperties
itinéraires	Liste des règles de routage fournies par l’utilisateur que le hub IoT utilise pour router 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.	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de file d’attente Service Bus	'identityBased' 'keyBased'
connectionString	Chaîne de connexion du point de terminaison de file d’attente Service Bus.	corde
endpointUri	URL du point de terminaison de file d’attente Service Bus. Il doit inclure le protocole sb://	corde
entityPath	Nom de la file d’attente sur l’espace de noms Service Bus	corde
id	ID du point de terminaison de file d’attente Service Bus	corde
identité	Propriétés d’identité managée du point de terminaison de file d’attente service bus de routage.	managedIdentity
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison. Le nom n’a pas besoin d’être identique au nom de file d’attente réel.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
resourceGroup	Nom du groupe de ressources du point de terminaison de file d’attente Service Bus.	corde
subscriptionId	Identificateur d’abonnement du point de terminaison de file d’attente Service Bus.	corde

RoutingServiceBusTopicEndpointProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de rubrique Service Bus	'identityBased' 'keyBased'
connectionString	Chaîne de connexion du point de terminaison de rubrique Service Bus.	corde
endpointUri	URL du point de terminaison de rubrique Service Bus. Il doit inclure le protocole sb://	corde
entityPath	Nom de la file d’attente dans la rubrique Service Bus	corde
id	ID du point de terminaison de rubrique Service Bus	corde
identité	Propriétés d’identité managée du point de terminaison de rubrique Service Bus de routage.	managedIdentity
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison. Le nom n’a pas besoin d’être identique au nom de la rubrique réelle.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
resourceGroup	Nom du groupe de ressources du point de terminaison de rubrique Service Bus.	corde
subscriptionId	Identificateur d’abonnement du point de terminaison de rubrique Service Bus.	corde

RoutingStorageContainerProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de stockage	'identityBased' 'keyBased'
batchFrequencyInSeconds	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 de 300 secondes.	Int Contraintes: Valeur minimale = 60 Valeur maximale = 720
connectionString	Chaîne de connexion du compte de stockage.	corde
containerName	Nom du conteneur de stockage dans le compte de stockage.	chaîne (obligatoire)
codage	Encodage utilisé pour sérialiser les messages vers des objets blob. Les valeurs prises en charge sont « avro », « avrodeflate » et « JSON ». La valeur par défaut est « avro ».	'Avro' 'AvroDeflate' 'JSON'
endpointUri	URL du point de terminaison de stockage. Il doit inclure le protocole https://	corde
fileNameFormat	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é.	corde
id	ID du point de terminaison du conteneur de stockage	corde
identité	Propriétés d’identité managée du point de terminaison de stockage de routage.	managedIdentity
maxChunkSizeInBytes	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).	Int Contraintes: Valeur minimale = 10485760 Valeur maximale = 524288000
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
resourceGroup	Nom du groupe de ressources du compte de stockage.	corde
subscriptionId	Identificateur d’abonnement du compte de stockage.	corde

SharedAccessSignatureAuthorizationRule

Nom	Description	Valeur
keyName	Nom de la stratégie d’accès partagé.	chaîne (obligatoire)
primaryKey	Clé primaire.	corde
droits	Autorisations affectées à la stratégie d’accès partagé.	'DeviceConnect' 'RegistryRead' 'RegistryRead, DeviceConnect' 'RegistryRead, RegistryWrite' 'RegistryRead, RegistryWrite, DeviceConnect' 'RegistryRead, RegistryWrite, ServiceConnect' « RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect » 'RegistryRead, ServiceConnect' ' RegistryRead, ServiceConnect, DeviceConnect' 'RegistryWrite' 'RegistryWrite, DeviceConnect' 'RegistryWrite, ServiceConnect' 'RegistryWrite, ServiceConnect, DeviceConnect' 'ServiceConnect' 'ServiceConnect, DeviceConnect' (obligatoire)
secondaryKey	Clé secondaire.	corde

StorageEndpointProperties

Nom	Description	Valeur
authenticationType	Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.	'identityBased' 'keyBased'
connectionString	Chaîne de connexion pour le compte stockage Azure vers lequel les fichiers sont chargés.	chaîne (obligatoire)
containerName	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 connectionString spécifié.	chaîne (obligatoire)
identité	Propriétés d’identité managée du point de terminaison de stockage pour le chargement de fichiers.	managedIdentity
sasTtlAsIso8601	Période pendant laquelle l’URI SAP généré par IoT Hub pour le chargement de fichiers est valide. Voir : /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	corde

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
créer un environnement pay as you go (PAYG) avec un IoT Hub	Ce modèle vous permet de déployer un environnement Time Series Insights de paiement à l’utilisation (PAYG) configuré pour consommer des événements à partir d’un Hub IoT.
créer un hub IoT et un groupe de consommateurs d’appareils vers le cloud	Ce modèle vous permet de déployer une instance IoT Hub avec un appareil vers le cloud et le cloud vers des configurations de messagerie d’appareil et un appareil dans un groupe de consommateurs cloud.
Créer un simulateur IOT Hub et Ubuntu Edge	Ce modèle crée un simulateur de périphérie Ubuntu iOT Hub et machine virtuelle.
créer un service IoT Hub Device Provisioning	Ce modèle vous permet de créer un hub IoT et un service IoT Hub Device Provisioning et de lier les deux services.
Créer une mise à jour d’appareil pour un compte IoT Hub, une instance, un IoT Hub	Ce modèle crée un compte, une instance et un hub pour lier l’instance. Il configure le hub avec les stratégies d’accès, les itinéraires et le groupe de consommateurs nécessaires.
déployer le service MedTech, y compris un Azure IoT Hub	Le service MedTech est l’un des services de données Azure Health conçus pour ingérer des données d’appareil à partir de plusieurs appareils, transformer les données d’appareil en observations FHIR, qui sont ensuite conservées dans le service FHIR Azure Health Data Services.
Utiliser un modèle ARM pour créer IoT Hub, acheminer et afficher des messages	Utilisez ce modèle pour déployer un hub IoT et un compte de stockage. Exécutez une application pour envoyer des messages au hub routés vers le stockage, puis affichez les résultats.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource IotHubs peut être déployé avec des opérations qui ciblent :

• groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Devices/IotHubs, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/IotHubs@2023-06-30"
  name = "string"
  etag = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      allowedFqdnList = [
        "string"
      ]
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      cloudToDevice = {
        defaultTtlAsIso8601 = "string"
        feedback = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
        maxDeliveryCount = int
      }
      comments = "string"
      disableDeviceSAS = bool
      disableLocalAuth = bool
      disableModuleSAS = bool
      enableDataResidency = bool
      enableFileUploadNotifications = bool
      eventHubEndpoints = {
        {customized property} = {
          partitionCount = int
          retentionTimeInDays = int
        }
      }
      features = "string"
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
        }
      ]
      messagingEndpoints = {
        {customized property} = {
          lockDurationAsIso8601 = "string"
          maxDeliveryCount = int
          ttlAsIso8601 = "string"
        }
      }
      minTlsVersion = "string"
      networkRuleSets = {
        applyToBuiltInEventHubEndpoint = bool
        defaultAction = "string"
        ipRules = [
          {
            action = "string"
            filterName = "string"
            ipMask = "string"
          }
        ]
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      restrictOutboundNetworkAccess = bool
      routing = {
        endpoints = {
          cosmosDBSqlContainers = [
            {
              authenticationType = "string"
              containerName = "string"
              databaseName = "string"
              endpointUri = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              partitionKeyName = "string"
              partitionKeyTemplate = "string"
              primaryKey = "string"
              resourceGroup = "string"
              secondaryKey = "string"
              subscriptionId = "string"
            }
          ]
          eventHubs = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusQueues = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          serviceBusTopics = [
            {
              authenticationType = "string"
              connectionString = "string"
              endpointUri = "string"
              entityPath = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
          storageContainers = [
            {
              authenticationType = "string"
              batchFrequencyInSeconds = int
              connectionString = "string"
              containerName = "string"
              encoding = "string"
              endpointUri = "string"
              fileNameFormat = "string"
              id = "string"
              identity = {
                userAssignedIdentity = "string"
              }
              maxChunkSizeInBytes = int
              name = "string"
              resourceGroup = "string"
              subscriptionId = "string"
            }
          ]
        }
        enrichments = [
          {
            endpointNames = [
              "string"
            ]
            key = "string"
            value = "string"
          }
        ]
        fallbackRoute = {
          condition = "string"
          endpointNames = [
            "string"
          ]
          isEnabled = bool
          name = "string"
          source = "string"
        }
        routes = [
          {
            condition = "string"
            endpointNames = [
              "string"
            ]
            isEnabled = bool
            name = "string"
            source = "string"
          }
        ]
      }
      storageEndpoints = {
        {customized property} = {
          authenticationType = "string"
          connectionString = "string"
          containerName = "string"
          identity = {
            userAssignedIdentity = "string"
          }
          sasTtlAsIso8601 = "string"
        }
      }
    }
  })
}

Valeurs de propriété

ArmIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Dictionnaire de <> ArmUserIdentity	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nom	Description	Valeur

ArmUserIdentity

Nom	Description	Valeur

CloudToDeviceProperties

Nom	Description	Valeur
defaultTtlAsIso8601	Heure par défaut de vie des messages cloud-à-appareil dans la file d’attente de l’appareil. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	corde
rétroaction	Propriétés de la file d’attente de commentaires pour les messages cloud-à-appareil.	FeedbackProperties
maxDeliveryCount	Nombre maximal de remises pour les messages cloud-à-appareil dans la file d’attente de l’appareil. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 100

EnrichmentProperties

Nom	Description	Valeur
endpointNames	Liste des points de terminaison pour lesquels l’enrichissement est appliqué au message.	string[] (obligatoire)
clé	Clé ou nom de la propriété d’enrichissement.	chaîne (obligatoire)
valeur	Valeur de la propriété d’enrichissement.	chaîne (obligatoire)

EventHubProperties

Nom	Description	Valeur
partitionCount	Nombre de partitions pour la réception de messages appareil-à-cloud dans le point de terminaison compatible Event Hub. Voir : /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	Int
retentionTimeInDays	Durée de rétention des messages appareil-à-cloud en jours. Voir : /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	Int

FallbackRouteProperties

Nom	Description	Valeur
condition	Condition évaluée pour appliquer l’itinéraire de secours. Si la condition n’est pas fournie, elle prend la valeur true par défaut. Pour la grammaire, consultez : /azure/iot-hub/iot-hub-devguide-query-language	corde
endpointNames	Liste des points de terminaison vers lesquels les messages qui répondent à la condition sont routés. Actuellement, seul 1 point de terminaison est autorisé.	string[] (obligatoire)
isEnabled	Permet de spécifier si l’itinéraire de secours est activé.	bool (obligatoire)
nom	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.	corde
source	Source à laquelle la règle de routage doit être appliquée. Par exemple, DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Invalid' 'TwinChangeEvents' (obligatoire)

FeedbackProperties

Nom	Description	Valeur
lockDurationAsIso8601	Durée de verrouillage de la file d’attente de commentaires. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	corde
maxDeliveryCount	Nombre de tentatives de remise d’un message sur la file d’attente de commentaires par le hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 100
ttlAsIso8601	Période pendant laquelle un message est disponible pour être consommé avant son expiration par le hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	corde

IotHubProperties

Nom	Description	Valeur
allowedFqdnList	Liste des noms de domaine complets autorisés (nom de domaine complet) pour la sortie à partir d’Iot Hub.	string[]
authorizationPolicies	Les stratégies d’accès partagé que vous pouvez utiliser pour sécuriser une connexion au hub IoT.	SharedAccessSignatureAuthorizationRule[]
cloudToDevice	Propriétés de messagerie cloud-à-appareil ioT Hub.	CloudToDeviceProperties
Commentaires	Commentaires ioT Hub.	corde
disableDeviceSAS	Si la valeur est true, tous les appareils (y compris les appareils Edge, mais à l’exclusion des modules) ne peuvent pas être utilisés pour l’authentification.	Bool
disableLocalAuth	Si la valeur est true, les jetons SAP avec des clés SAP étendues Iot hub ne peuvent pas être utilisés pour l’authentification.	Bool
disableModuleSAS	Si la valeur est true, toutes les clés SAP étendues au module ne peuvent pas être utilisées pour l’authentification.	Bool
enableDataResidency	Cette propriété lorsqu’elle est définie sur true active la résidence des données, ce qui désactive la récupération d’urgence.	Bool
enableFileUploadNotifications	Si la valeur est True, les notifications de chargement de fichiers sont activées.	Bool
eventHubEndpoints	Propriétés de point de terminaison compatibles avec Event Hub. La seule clé possible pour ce dictionnaire est les événements. Cette clé doit être présente dans le dictionnaire tout en effectuant des appels de création ou de mise à jour pour le hub IoT.	IotHubPropertiesEventHubEndpoints
fonctionnalités	Fonctionnalités et fonctionnalités activées pour le hub IoT.	'DeviceManagement' 'None'
ipFilterRules	Règles de filtre IP.	IpFilterRule []
messagingEndpoints	Propriétés du point de terminaison de messagerie pour la file d’attente de notification de chargement de fichier.	IotHubPropertiesMessagingEndpoints
minTlsVersion	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 à la version 1.2 soient rejetés.	corde
networkRuleSets	Propriétés de l’ensemble de règles réseau d’IotHub	NetworkRuleSetProperties
privateEndpointConnections	Connexions de point de terminaison privé créées sur cet IotHub	PrivateEndpointConnection[]
publicNetworkAccess	Indique si les demandes du réseau public sont autorisées	'Désactivé' 'Activé'
restrictOutboundNetworkAccess	Si la valeur est true, la sortie d’IotHub est limitée uniquement aux noms de domaine complets autorisés configurés via allowedFqdnList.	Bool
routage	Propriétés associées au routage du hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	Liste des points de terminaison stockage Azure où vous pouvez charger des fichiers. Actuellement, vous ne pouvez configurer qu’un seul compte stockage Azure et qui doit avoir sa clé comme $default. La spécification de plusieurs comptes de stockage provoque 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 générée.	IotHubPropertiesStorageEndpoints

IotHubPropertiesEventHubEndpoints

Nom	Description	Valeur

IotHubPropertiesMessagingEndpoints

Nom	Description	Valeur

IotHubPropertiesStorageEndpoints

Nom	Description	Valeur

IotHubSkuInfo

Nom	Description	Valeur
capacité	Nombre d’unités IoT Hub approvisionnées. Consultez : /azure/azure-subscription-service-limits#iot-hub-limits.	Int
nom	Nom de la référence SKU.	'B1' 'B2' 'B3' 'F1' 'S1' 'S2' 'S3' (obligatoire)

IpFilterRule

Nom	Description	Valeur
action	Action souhaitée pour les demandes capturées par cette règle.	'Accepter' 'Reject' (obligatoire)
filterName	Nom de la règle de filtre IP.	chaîne (obligatoire)
ipMask	Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.	chaîne (obligatoire)

ManagedIdentity

Nom	Description	Valeur
userAssignedIdentity	Identité affectée par l’utilisateur.	corde

MessagingEndpointProperties

Nom	Description	Valeur
lockDurationAsIso8601	Durée du verrou. Voir : /azure/iot-hub/iot-hub-devguide-file-upload.	corde
maxDeliveryCount	Nombre de tentatives de remise d’un message par le hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-file-upload.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 100
ttlAsIso8601	Période pendant laquelle un message est disponible pour être consommé avant son expiration par le hub IoT. Voir : /azure/iot-hub/iot-hub-devguide-file-upload.	corde

Microsoft.Devices/IotHubs

Nom	Description	Valeur
etag	Le champ Etag n’est pas requis. S’il est fourni dans le corps de la réponse, il doit également être fourni en tant qu’en-tête conformément à la convention ETag normale.	corde
identité	Identités managées pour IotHub.	ArmIdentity
emplacement	Emplacement de la ressource.	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés IotHub	IotHubProperties
Sku	Informations sur la référence SKU IotHub	IotHubSkuInfo (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
type	Type de ressource	« Microsoft.Devices/IotHubs@2023-06-30 »

NetworkRuleSetIpRule

Nom	Description	Valeur
action	Action de filtre IP	'Autoriser'
filterName	Nom de la règle de filtre IP.	chaîne (obligatoire)
ipMask	Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.	chaîne (obligatoire)

NetworkRuleSetProperties

Nom	Description	Valeur
applyToBuiltInEventHubEndpoint	Si la valeur est True, l’ensemble de règles réseau est également appliqué à BuiltIn EventHub EndPoint d’IotHub	bool (obligatoire)
defaultAction	Action par défaut pour l’ensemble de règles réseau	'Autoriser' 'Refuser'
ipRules	Liste des règles IP	NetworkRuleSetIpRule[] (obligatoire)

PrivateEndpoint

Nom	Description	Valeur

PrivateEndpointConnection

Nom	Description	Valeur
Propriétés	Propriétés d’une connexion de point de terminaison privé	PrivateEndpointConnectionProperties (obligatoire)

PrivateEndpointConnectionProperties

Nom	Description	Valeur
privateEndpoint	Propriété de point de terminaison privé d’une connexion de point de terminaison privé	PrivateEndpoint
privateLinkServiceConnectionState	État actuel d’une connexion de point de terminaison privé	PrivateLinkServiceConnectionState (obligatoire)

PrivateLinkServiceConnectionState

Nom	Description	Valeur
actionsRequired	Actions requises pour une connexion de point de terminaison privé	corde
description	Description de l’état actuel d’une connexion de point de terminaison privé	chaîne (obligatoire)
statut	État d’une connexion de point de terminaison privé	'Approuvé' 'Déconnecté' 'En attente' 'Rejeté' (obligatoire)

ResourceTags

Nom	Description	Valeur

RouteProperties

Nom	Description	Valeur
condition	Condition évaluée pour appliquer la règle de routage. Si aucune condition n’est fournie, elle prend la valeur true par défaut. Pour la grammaire, consultez : /azure/iot-hub/iot-hub-devguide-query-language	corde
endpointNames	Liste des points de terminaison vers lesquels les messages qui répondent à la condition sont routés. Actuellement, un seul point de terminaison est autorisé.	string[] (obligatoire)
isEnabled	Permet de spécifier si un itinéraire est activé.	bool (obligatoire)
nom	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.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
source	Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Invalid' 'TwinChangeEvents' (obligatoire)

RoutingCosmosDBSqlApiProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de conteneur sql cosmos DB	'identityBased' 'keyBased'
containerName	Nom du conteneur sql cosmos DB dans la base de données Cosmos DB.	chaîne (obligatoire)
databaseName	Nom de la base de données cosmos DB dans le compte cosmos DB.	chaîne (obligatoire)
endpointUri	URL du compte cosmos DB. Il doit inclure le protocole https://	chaîne (obligatoire)
identité	Propriétés d’identité managée du point de terminaison de conteneur cosmos DB de routage.	managedIdentity
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
partitionKeyName	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.	corde
partitionKeyTemplate	Modèle de génération d’une valeur de clé de partition synthétique à utiliser avec ce conteneur sql cosmos DB. Le modèle doit inclure au moins l’un des espaces réservés suivants : {iothub}, {deviceid}, {DD}, {MM}et {AAAA}. Tous les espaces réservés peuvent être spécifiés au maximum une fois, mais les composants de commande et non-espace réservé sont arbitraires. Ce paramètre est obligatoire uniquement si PartitionKeyName est spécifié.	corde
primaryKey	Clé primaire du compte Cosmos DB.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
resourceGroup	Nom du groupe de ressources du compte cosmos DB.	corde
secondaryKey	Clé secondaire du compte Cosmos DB.	corde Contraintes: Valeur sensible. Passez en tant que paramètre sécurisé.
subscriptionId	Identificateur d’abonnement du compte Cosmos DB.	corde

RoutingEndpoints

Nom	Description	Valeur
cosmosDBSqlContainers	La liste des points de terminaison de conteneur Cosmos DB vers utilisant IoT Hub achemine les messages en fonction des règles de routage.	RoutingCosmosDBSqlApiProperties[]
eventHubs	Liste des points de terminaison Event Hubs 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é.	RoutingEventHubProperties[]
serviceBusQueues	Liste des points de terminaison de file d’attente Service Bus auxquels IoT Hub achemine les messages en fonction des règles de routage.	RoutingServiceBusQueueEndpointProperties[]
serviceBusTopics	Liste des points de terminaison de rubrique Service Bus auxquels le hub IoT achemine les messages en fonction des règles de routage.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	Liste des points de terminaison de conteneur de stockage vers utilisant ioT Hub qui acheminent les messages en fonction des règles de routage.	RoutingStorageContainerProperties[]

RoutingEventHubProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison event Hub	'identityBased' 'keyBased'
connectionString	Chaîne de connexion du point de terminaison event Hub.	corde
endpointUri	URL du point de terminaison event Hub. Il doit inclure le protocole sb://	corde
entityPath	Nom du hub d’événements sur l’espace de noms du hub d’événements	corde
id	ID du point de terminaison du hub d’événements	corde
identité	Propriétés d’identité managée du point de terminaison event Hub de routage.	managedIdentity
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
resourceGroup	Nom du groupe de ressources du point de terminaison event Hub.	corde
subscriptionId	Identificateur d’abonnement du point de terminaison event Hub.	corde

RoutingProperties

Nom	Description	Valeur
Terminaison	Propriétés liées aux points de terminaison personnalisés auxquels 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.	RoutingEndpoints
enrichissements	Liste des enrichissements fournis par l’utilisateur que le hub IoT s’applique aux messages à remettre aux points de terminaison intégrés et personnalisés. Voir : https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	Propriétés de l’itinéraire utilisé comme itinéraire de secours quand 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, l’itinéraire de secours est désactivé par défaut.	FallbackRouteProperties
itinéraires	Liste des règles de routage fournies par l’utilisateur que le hub IoT utilise pour router 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.	RouteProperties[]

RoutingServiceBusQueueEndpointProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de file d’attente Service Bus	'identityBased' 'keyBased'
connectionString	Chaîne de connexion du point de terminaison de file d’attente Service Bus.	corde
endpointUri	URL du point de terminaison de file d’attente Service Bus. Il doit inclure le protocole sb://	corde
entityPath	Nom de la file d’attente sur l’espace de noms Service Bus	corde
id	ID du point de terminaison de file d’attente Service Bus	corde
identité	Propriétés d’identité managée du point de terminaison de file d’attente service bus de routage.	managedIdentity
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison. Le nom n’a pas besoin d’être identique au nom de file d’attente réel.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
resourceGroup	Nom du groupe de ressources du point de terminaison de file d’attente Service Bus.	corde
subscriptionId	Identificateur d’abonnement du point de terminaison de file d’attente Service Bus.	corde

RoutingServiceBusTopicEndpointProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de rubrique Service Bus	'identityBased' 'keyBased'
connectionString	Chaîne de connexion du point de terminaison de rubrique Service Bus.	corde
endpointUri	URL du point de terminaison de rubrique Service Bus. Il doit inclure le protocole sb://	corde
entityPath	Nom de la file d’attente dans la rubrique Service Bus	corde
id	ID du point de terminaison de rubrique Service Bus	corde
identité	Propriétés d’identité managée du point de terminaison de rubrique Service Bus de routage.	managedIdentity
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison. Le nom n’a pas besoin d’être identique au nom de la rubrique réelle.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
resourceGroup	Nom du groupe de ressources du point de terminaison de rubrique Service Bus.	corde
subscriptionId	Identificateur d’abonnement du point de terminaison de rubrique Service Bus.	corde

RoutingStorageContainerProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de stockage	'identityBased' 'keyBased'
batchFrequencyInSeconds	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 de 300 secondes.	Int Contraintes: Valeur minimale = 60 Valeur maximale = 720
connectionString	Chaîne de connexion du compte de stockage.	corde
containerName	Nom du conteneur de stockage dans le compte de stockage.	chaîne (obligatoire)
codage	Encodage utilisé pour sérialiser les messages vers des objets blob. Les valeurs prises en charge sont « avro », « avrodeflate » et « JSON ». La valeur par défaut est « avro ».	'Avro' 'AvroDeflate' 'JSON'
endpointUri	URL du point de terminaison de stockage. Il doit inclure le protocole https://	corde
fileNameFormat	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é.	corde
id	ID du point de terminaison du conteneur de stockage	corde
identité	Propriétés d’identité managée du point de terminaison de stockage de routage.	managedIdentity
maxChunkSizeInBytes	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).	Int Contraintes: Valeur minimale = 10485760 Valeur maximale = 524288000
nom	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 une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.	corde Contraintes: Modèle = ^[A-Za-z0-9-._]{1,64}$ (obligatoire)
resourceGroup	Nom du groupe de ressources du compte de stockage.	corde
subscriptionId	Identificateur d’abonnement du compte de stockage.	corde

SharedAccessSignatureAuthorizationRule

Nom	Description	Valeur
keyName	Nom de la stratégie d’accès partagé.	chaîne (obligatoire)
primaryKey	Clé primaire.	corde
droits	Autorisations affectées à la stratégie d’accès partagé.	'DeviceConnect' 'RegistryRead' 'RegistryRead, DeviceConnect' 'RegistryRead, RegistryWrite' 'RegistryRead, RegistryWrite, DeviceConnect' 'RegistryRead, RegistryWrite, ServiceConnect' « RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect » 'RegistryRead, ServiceConnect' ' RegistryRead, ServiceConnect, DeviceConnect' 'RegistryWrite' 'RegistryWrite, DeviceConnect' 'RegistryWrite, ServiceConnect' 'RegistryWrite, ServiceConnect, DeviceConnect' 'ServiceConnect' 'ServiceConnect, DeviceConnect' (obligatoire)
secondaryKey	Clé secondaire.	corde

StorageEndpointProperties

Nom	Description	Valeur
authenticationType	Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.	'identityBased' 'keyBased'
connectionString	Chaîne de connexion pour le compte stockage Azure vers lequel les fichiers sont chargés.	chaîne (obligatoire)
containerName	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 connectionString spécifié.	chaîne (obligatoire)
identité	Propriétés d’identité managée du point de terminaison de stockage pour le chargement de fichiers.	managedIdentity
sasTtlAsIso8601	Période pendant laquelle l’URI SAP généré par IoT Hub pour le chargement de fichiers est valide. Voir : /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	corde