Microsoft.Devices IotHubs

• La plus récente
• 2023-06-30
• 2023-06-30-preview
• 2022-11-15-preview
• 2022-04-30-preview
• 2021-07-02
• 2021-07-02-preview
• 01-07-2021
• 2021-07-01-preview
• 31/03/2021
• 2021-03-03-preview
• 2021-02-01-preview

Définition de ressource Bicep

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

• Groupes de ressources - Voir 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 des ressources

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

resource symbolicname 'Microsoft.Devices/IotHubs@2023-06-30' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    allowedFqdnList: [
      'string'
    ]
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
        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: 'Allow'
          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és

IoTHubs

Nom	Description	Valeur
name	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 3-50 Caractères valides : Caractères alphanumériques et traits d’union. Ne peut pas se terminer par un trait d’union. Le nom de la ressource doit être unique dans Azure.
location	Emplacement de la ressource.	chaîne (obligatoire)
tags	Étiquettes de la ressource.	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku	Informations sur la référence SKU IotHub	IotHubSkuInfo (obligatoire)
etag	Le champ Etag n’est pas obligatoire. 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.	string
identité	Identités managées pour IotHub.	ArmIdentity
properties	Propriétés IotHub	IotHubProperties

ArmIdentity

Nom	Description	Valeur
type	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.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Dictionnaire de {ArmUserIdentity}	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nom	Description	Valeur
{propriété personnalisée}		ArmUserIdentity

ArmUserIdentity

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

IotHubProperties

Nom	Description	Valeur
allowedFqdnList	Liste des noms de domaine complets (nom de domaine complet) autorisés pour la sortie à partir d’Iot Hub.	string[]
authorizationPolicies	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
comments	Commentaires IoT Hub.	string
disableDeviceSAS	Si la valeur est true, toutes les clés SAP étendues à l’ensemble des appareils (y compris les appareils Edge, mais à l’exclusion des modules) ne peuvent pas être utilisées pour l’authentification.	bool
disableLocalAuth	Si la valeur est true, les jetons SAP avec des clés SAS étendues au hub Iot 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	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.	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. 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.	IotHubPropertiesEventHubEndpoints
features	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 à 1.2 soient rejetés.	string
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	Si les demandes provenant du réseau public sont autorisées	'Désactivé' 'Enabled'
restrictOutboundNetworkAccess	Si la valeur est true, la sortie d’IotHub est limitée aux noms de domaine complets autorisés configurés via allowedFqdnList.	bool
routage	Propriétés liées au routage du hub IoT. Consultez : /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	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.	IotHubPropertiesStorageEndpoints

SharedAccessSignatureAuthorizationRule

Nom	Description	Valeur
keyName	Nom de la stratégie d’accès partagé.	string (obligatoire)
primaryKey	Clé primaire.	string
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.	string
keyName	Nom de la stratégie d’accès partagé.	string (obligatoire)
primaryKey	Clé primaire.	string
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.	string

CloudToDeviceProperties

Nom	Description	Valeur
defaultTtlAsIso8601	Durée de vie par défaut pour les messages cloud-à-appareil dans la file d’attente d’appareil. Consultez : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string
feedback	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 des appareils. Consultez : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	int Contraintes : Valeur minimale = 1 Valeur maximale = 100

FeedbackProperties

Nom	Description	Valeur
lockDurationAsIso8601	Durée de verrouillage de la file d’attente de commentaires. Consultez : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string
maxDeliveryCount	Nombre de fois où le hub IoT tente de remettre un message sur la file d’attente de commentaires. Consultez : /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. Consultez : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string

IotHubPropertiesEventHubEndpoints

Nom	Description	Valeur
{propriété personnalisée}		EventHubProperties

EventHubProperties

Nom	Description	Valeur
partitionCount	Nombre de partitions permettant de recevoir des messages appareil-à-cloud dans le point de terminaison compatible avec Event Hub. Consultez : /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	int
retentionTimeInDays	Durée de rétention des messages appareil-à-cloud en jours. Consultez : /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	int

IpFilterRule

Nom	Description	Valeur
action	Action souhaitée pour les requêtes 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)

IotHubPropertiesMessagingEndpoints

Nom	Description	Valeur
{propriété personnalisée}		MessagingEndpointProperties

MessagingEndpointProperties

Nom	Description	Valeur
lockDurationAsIso8601	Durée du verrou. Consultez : /azure/iot-hub/iot-hub-devguide-file-upload.	string
maxDeliveryCount	Nombre de fois où le hub IoT tente de remettre un message. Consultez : /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. Consultez : /azure/iot-hub/iot-hub-devguide-file-upload.	string

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' 'Deny'
ipRules	Liste des règles IP	NetworkRuleSetIpRule[] (obligatoire)

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)

PrivateEndpointConnection

Nom	Description	Valeur
properties	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)

PrivateEndpoint

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

PrivateLinkServiceConnectionState

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

RoutingProperties

Nom	Description	Valeur
points de terminaison	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.	RoutageEndpoints
enrichissements	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	EnrichmentProperties[]
fallbackRoute	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.	FallbackRouteProperties
itinéraires	Liste des règles de routage fournies par l’utilisateur que l’IoT Hub 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.	RouteProperties[]

RoutageEndpoints

Nom	Description	Valeur
cosmosDBSqlContainers	Liste des points de terminaison de conteneur Cosmos DB auxquels IoT Hub achemine les messages, en fonction des règles de routage.	RoutageCosmosDBSqlApiProperties[]
eventHubs	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é.	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 l’IoT Hub achemine les messages, en fonction des règles de routage.	RoutingServiceBusTopicEndpointProperties[]
storageContainers	Liste des points de terminaison de conteneur de stockage auxquels IoT Hub achemine les messages, en fonction des règles de routage.	RoutingStorageContainerProperties[]

RoutageCosmosDBSqlApiProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour l’authentification 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
name	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 : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques parmi les types de points de terminaison.	chaîne (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
partitionKeyName	Nom de la clé de partition associée à ce conteneur sql cosmos DB, le cas échéant. Il s'agit d'un paramètre facultatif.	string
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 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 les composants d’ordre et non réservé sont arbitraires. Ce paramètre n’est requis que si PartitionKeyName est spécifié.	string
primaryKey	Clé primaire du compte cosmos DB.	string Contraintes : Valeur sensible. Passez en tant que paramètre sécurisé.
resourceGroup	Nom du groupe de ressources du compte cosmos DB.	string
secondaryKey	Clé secondaire du compte cosmos DB.	string Contraintes : Valeur sensible. Passez en tant que paramètre sécurisé.
subscriptionId	Identificateur d’abonnement du compte cosmos DB.	string

ManagedIdentity

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

RoutingEventHubProperties

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

RoutingServiceBusQueueEndpointProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour l’authentification 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.	string
endpointUri	URL du point de terminaison de file d’attente Service Bus. Il doit inclure le protocole sb://	string
entityPath	Nom de la file d’attente dans l’espace de noms Service Bus	string
id	ID du point de terminaison de file d’attente Service Bus	string
identité	Propriétés d’identité managée du point de terminaison de file d’attente service bus de routage.	ManagedIdentity
name	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 : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques parmi les types de points de terminaison. Le nom ne doit pas nécessairement être identique au nom réel de la file d’attente.	chaîne (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nom du groupe de ressources du point de terminaison de file d’attente Service Bus.	string
subscriptionId	Identificateur d’abonnement du point de terminaison de file d’attente Service Bus.	string

RoutingServiceBusTopicEndpointProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour l’authentification 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.	string
endpointUri	URL du point de terminaison de rubrique Service Bus. Il doit inclure le protocole sb://	string
entityPath	Nom de la file d’attente dans la rubrique Service Bus	string
id	ID du point de terminaison de rubrique Service Bus	string
identité	Propriétés d’identité managée du point de terminaison de rubrique Service Bus de routage.	ManagedIdentity
name	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 : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques parmi les types de points de terminaison. Le nom ne doit pas nécessairement être identique au nom réel de la rubrique.	chaîne (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nom du groupe de ressources du point de terminaison de rubrique Service Bus.	string
subscriptionId	Identificateur d’abonnement du point de terminaison de rubrique Service Bus.	string

RoutingStorageContainerProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour l’authentification 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 300 secondes.	int Contraintes : Valeur minimale = 60 Valeur maximale = 720
connectionString	Chaîne de connexion du compte de stockage.	string
containerName	Nom du conteneur de stockage dans le compte de stockage.	chaîne (obligatoire)
encodage	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'.	'Avro' 'AvroDeflate' 'JSON'
endpointUri	URL du point de terminaison de stockage. Il doit inclure le protocole https://	string
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és.	string
id	ID du point de terminaison du conteneur de stockage	string
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
name	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 : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques parmi les types de points de terminaison.	chaîne (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nom du groupe de ressources du compte de stockage.	string
subscriptionId	Identificateur d’abonnement du compte de stockage.	string

EnrichmentProperties

Nom	Description	Valeur
endpointNames	Liste des points de terminaison pour lesquels l’enrichissement est appliqué au message.	string[] (obligatoire) Contraintes : Longueur minimale = 1
key	Clé ou nom de la propriété d’enrichissement.	chaîne (obligatoire)
value	Valeur de la propriété d’enrichissement.	chaîne (obligatoire)

FallbackRouteProperties

Nom	Description	Valeur
condition	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 : /azure/iot-hub/iot-hub-devguide-query-language	string
endpointNames	Liste des points de terminaison vers lesquels les messages qui satisfont à la condition sont routés. Actuellement, un seul point de terminaison est autorisé.	string[] (obligatoire) Contraintes : Longueur minimale = 1 Longueur maximale = 1
isEnabled	Permet de spécifier si l’itinéraire de secours est activé.	bool (obligatoire)
name	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.	string
source	Source à laquelle la règle de routage doit être appliquée. Par exemple, DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Non valide' 'TwinChangeEvents' (obligatoire)

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	string
endpointNames	Liste des points de terminaison vers lesquels les messages qui satisfont à la condition sont routés. Actuellement, un seul point de terminaison est autorisé.	string[] (obligatoire) Contraintes : Longueur minimale = 1 Longueur maximale = 1
isEnabled	Permet de spécifier si un itinéraire est activé.	bool (obligatoire)
name	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.	string (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
source	Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Invalid' 'TwinChangeEvents' (obligatoire)

IotHubPropertiesStorageEndpoints

Nom	Description	Valeur
{propriété personnalisée}		StorageEndpointProperties

StorageEndpointProperties

Nom	Description	Valeur
authenticationType	Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.	'identityBased' 'keyBased'
connectionString	La chaîne de connexion pour le compte de stockage Azure vers lequel les fichiers sont chargés.	string (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 la connectionString spécifiée.	string (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. Consultez : /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	string

IotHubSkuInfo

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

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 simulateur de périphérie IOT Hub et Ubuntu	Ce modèle crée un hub IOT et un simulateur de périphérie Ubuntu de machine virtuelle.
Utiliser un modèle ARM pour créer des IoT Hub, router et afficher des messages	Utilisez ce modèle pour déployer un IoT Hub 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.
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 un IoT Hub et un groupe de consommateurs Appareil à cloud	Ce modèle vous permet de déployer un IoT Hub instance avec des configurations de messagerie appareil-à-cloud et cloud-appareil et un groupe de consommateurs d’appareil à cloud.
Créer Device Update pour IoT Hub compte, instance IoT Hub	Ce modèle crée un compte, un instance et un hub pour lier les 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 Azure Health Data Services conçu pour ingérer des données d’appareil à partir de plusieurs appareils, transformer les données de l’appareil en observations FHIR, qui sont ensuite conservées dans le service FHIR Azure Health Data Services.
Créer un environnement de paiement à l’utilisation (PAYG) avec un IoT Hub	Ce modèle vous permet de déployer un environnement Pay As You Go (PAYG) Time Series Insights configuré pour consommer des événements à partir d’un IoT Hub.

Définition de ressources de modèle ARM

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

• Groupes de ressources - Voir commandes de déploiement de groupe de ressources

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

Format des ressources

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

{
  "type": "Microsoft.Devices/IotHubs",
  "apiVersion": "2023-06-30",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "allowedFqdnList": [ "string" ],
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string",
        "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": "Allow",
          "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és

IoTHubs

Nom	Description	Valeur
type	Type de ressource	'Microsoft.Devices/IotHubs'
apiVersion	Version de l’API de ressource	'2023-06-30'
name	Nom de la ressource	string (obligatoire) Limite de caractères : 3-50 Caractères valides : Caractères alphanumériques et traits d’union. Ne peut pas se terminer par un trait d’union. Le nom de la ressource doit être unique dans Azure.
location	Emplacement de la ressource.	string (obligatoire)
tags	Étiquettes de la ressource.	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku	Informations sur la référence SKU IotHub	IotHubSkuInfo (obligatoire)
etag	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.	string
identité	Identités managées pour IotHub.	ArmIdentity
properties	Propriétés IotHub	IotHubProperties

ArmIdentity

Nom	Description	Valeur
type	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.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Dictionnaire de {ArmUserIdentity}	ArmIdentityUserAssignedIdentities

ArmIdentityUserAssignedIdentities

Nom	Description	Valeur
{propriété personnalisée}		ArmUserIdentity

ArmUserIdentity

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

IotHubProperties

Nom	Description	Valeur
allowedFqdnList	Liste des noms de domaine complets (FQDN) autorisés pour les sorties à 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
comments	Commentaires du hub IoT.	string
disableDeviceSAS	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.	bool
disableLocalAuth	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.	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	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.	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. Les seules clés possibles de ce dictionnaire sont les événements. Cette clé doit être présente dans le dictionnaire lors de la création ou de la mise à jour des appels pour le hub IoT.	IotHubPropertiesEventHubEndpoints
features	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 à 1.2 soient rejetés.	string
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	Si les requêtes provenant du réseau public sont autorisées	'Désactivé' 'Enabled'
restreindreOutboundNetworkAccess	Si la valeur est true, la sortie d’IotHub sera limitée aux noms de domaine complets autorisés configurés via allowedFqdnList.	bool
routage	Propriétés liées au routage du hub IoT. Consultez : /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 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.	IotHubPropertiesStorageEndpoints

SharedAccessSignatureAuthorizationRule

Nom	Description	Valeur
keyName	Nom de la stratégie d’accès partagé.	chaîne (obligatoire)
primaryKey	Clé primaire.	string
droits	Autorisations attribué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.	string
keyName	Nom de la stratégie d’accès partagé.	chaîne (obligatoire)
primaryKey	Clé primaire.	string
droits	Autorisations attribué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.	string

CloudToDeviceProperties

Nom	Description	Valeur
defaultTtlAsIso8601	Durée de vie par défaut pour les messages cloud-à-appareil dans la file d’attente d’appareil. Consultez : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string
feedback	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 des appareils. Consultez : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	int Contraintes : Valeur minimale = 1 Valeur maximale = 100

FeedbackProperties

Nom	Description	Valeur
lockDurationAsIso8601	Durée de verrouillage de la file d’attente de commentaires. Consultez : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string
maxDeliveryCount	Nombre de fois où le hub IoT tente de remettre un message sur la file d’attente de commentaires. Consultez : /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. Consultez : /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string

IotHubPropertiesEventHubEndpoints

Nom	Description	Valeur
{propriété personnalisée}		EventHubProperties

EventHubProperties

Nom	Description	Valeur
partitionCount	Nombre de partitions permettant de recevoir des messages appareil-à-cloud dans le point de terminaison compatible avec Event Hub. Consultez : /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.	int
retentionTimeInDays	Durée de rétention des messages appareil-à-cloud en jours. Consultez : /azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages	int

IpFilterRule

Nom	Description	Valeur
action	Action souhaitée pour les requêtes 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)

IotHubPropertiesMessagingEndpoints

Nom	Description	Valeur
{propriété personnalisée}		MessagingEndpointProperties

MessagingEndpointProperties

Nom	Description	Valeur
lockDurationAsIso8601	Durée du verrou. Consultez : /azure/iot-hub/iot-hub-devguide-file-upload.	string
maxDeliveryCount	Nombre de fois où le hub IoT tente de remettre un message. Consultez : /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. Consultez : /azure/iot-hub/iot-hub-devguide-file-upload.	string

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' 'Deny'
ipRules	Liste des règles IP	NetworkRuleSetIpRule[] (obligatoire)

NetworkRuleSetIpRule

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

PrivateEndpointConnection

Nom	Description	Valeur
properties	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)

PrivateEndpoint

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

PrivateLinkServiceConnectionState

Nom	Description	Valeur
actionsRequired	Actions requises pour une connexion de point de terminaison privé	string
description	Description de l’état actuel d’une connexion de point de terminaison privé	string (obligatoire)
status	Status d’une connexion de point de terminaison privé	'Approuvé' 'Déconnecté' 'En attente' 'Rejected' (obligatoire)

RoutingProperties

Nom	Description	Valeur
points de terminaison	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.	RoutingEndpoints
enrichissements	Liste des enrichissements fournis par l’utilisateur que le hub IoT applique aux messages à remettre aux points de terminaison intégrés et personnalisés. Consultez : https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	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, 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 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.	RouteProperties[]

RoutingEndpoints

Nom	Description	Valeur
cosmosDBSqlContainers	Liste des points de terminaison de conteneur Cosmos DB auxquels 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 auxquels IoT Hub achemine les messages, en fonction des règles de routage.	RoutingStorageContainerProperties[]

RoutageCosmosDBSqlApiProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour l’authentification 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
name	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 : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques parmi les types de points de terminaison.	chaîne (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
partitionKeyName	Nom de la clé de partition associée à ce conteneur sql cosmos DB, le cas échéant. Il s'agit d'un paramètre facultatif.	string
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 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 les composants d’ordre et non réservé sont arbitraires. Ce paramètre n’est requis que si PartitionKeyName est spécifié.	string
primaryKey	Clé primaire du compte cosmos DB.	string Contraintes : Valeur sensible. Passez en tant que paramètre sécurisé.
resourceGroup	Nom du groupe de ressources du compte cosmos DB.	string
secondaryKey	Clé secondaire du compte cosmos DB.	string Contraintes : Valeur sensible. Passez en tant que paramètre sécurisé.
subscriptionId	Identificateur d’abonnement du compte cosmos DB.	string

ManagedIdentity

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

RoutingEventHubProperties

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

RoutingServiceBusQueueEndpointProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour l’authentification 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.	string
endpointUri	URL du point de terminaison de file d’attente Service Bus. Il doit inclure le protocole sb://	string
entityPath	Nom de la file d’attente dans l’espace de noms Service Bus	string
id	ID du point de terminaison de file d’attente Service Bus	string
identité	Propriétés d’identité managée du point de terminaison de file d’attente service bus de routage.	ManagedIdentity
name	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 : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques parmi les types de points de terminaison. Le nom ne doit pas nécessairement être identique au nom réel de la file d’attente.	chaîne (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nom du groupe de ressources du point de terminaison de file d’attente Service Bus.	string
subscriptionId	Identificateur d’abonnement du point de terminaison de file d’attente Service Bus.	string

RoutingServiceBusTopicEndpointProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour l’authentification 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.	string
endpointUri	URL du point de terminaison de rubrique Service Bus. Il doit inclure le protocole sb://	string
entityPath	Nom de la file d’attente dans la rubrique Service Bus	string
id	ID du point de terminaison de rubrique Service Bus	string
identité	Propriétés d’identité managée du point de terminaison de rubrique Service Bus de routage.	ManagedIdentity
name	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 : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques parmi les types de points de terminaison. Le nom ne doit pas nécessairement être identique au nom réel de la rubrique.	chaîne (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nom du groupe de ressources du point de terminaison de rubrique Service Bus.	string
subscriptionId	Identificateur d’abonnement du point de terminaison de rubrique Service Bus.	string

RoutingStorageContainerProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour l’authentification 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 300 secondes.	int Contraintes : Valeur minimale = 60 Valeur maximale = 720
connectionString	Chaîne de connexion du compte de stockage.	string
containerName	Nom du conteneur de stockage dans le compte de stockage.	string (obligatoire)
encodage	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 ».	'Avro' 'AvroDeflate' 'JSON'
endpointUri	URL du point de terminaison de stockage. Il doit inclure le protocole https://	string
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és.	string
id	ID du point de terminaison du conteneur de stockage	string
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
name	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.	string (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nom du groupe de ressources du compte de stockage.	string
subscriptionId	Identificateur d’abonnement du compte de stockage.	string

EnrichmentProperties

Nom	Description	Valeur
endpointNames	Liste des points de terminaison pour lesquels l’enrichissement est appliqué au message.	string[] (obligatoire) Contraintes : Longueur minimale = 1
key	Clé ou nom de la propriété d’enrichissement.	string (obligatoire)
value	Valeur de la propriété d’enrichissement.	string (obligatoire)

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	string
endpointNames	Liste des points de terminaison vers lesquels les messages qui satisfont à la condition sont routés. Actuellement, un seul point de terminaison est autorisé.	string[] (obligatoire) Contraintes : Longueur minimale = 1 Longueur maximale = 1
isEnabled	Permet de spécifier si l’itinéraire de secours est activé.	bool (obligatoire)
name	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.	string
source	Source à laquelle la règle de routage doit être appliquée. Par exemple, DeviceMessages	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Invalid' 'TwinChangeEvents' (obligatoire)

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	string
endpointNames	Liste des points de terminaison vers lesquels les messages qui satisfont à la condition sont routés. Actuellement, un seul point de terminaison est autorisé.	string[] (obligatoire) Contraintes : Longueur minimale = 1 Longueur maximale = 1
isEnabled	Permet de spécifier si un itinéraire est activé.	bool (obligatoire)
name	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.	string (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
source	Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.	'DeviceConnectionStateEvents' 'DeviceJobLifecycleEvents' 'DeviceLifecycleEvents' 'DeviceMessages' 'Invalid' 'TwinChangeEvents' (obligatoire)

IotHubPropertiesStorageEndpoints

Nom	Description	Valeur
{propriété personnalisée}		StorageEndpointProperties

StorageEndpointProperties

Nom	Description	Valeur
authenticationType	Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.	'identityBased' 'keyBased'
connectionString	La chaîne de connexion pour le compte de stockage Azure vers lequel les fichiers sont chargés.	string (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 la connectionString spécifiée.	string (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. Consultez : /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	string

IotHubSkuInfo

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

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 simulateur de périphérie IOT Hub et Ubuntu	Ce modèle crée un hub IOT et un simulateur de périphérie Ubuntu de machine virtuelle.
Utiliser un modèle ARM pour créer des IoT Hub, router et afficher des messages	Utilisez ce modèle pour déployer un IoT Hub 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.
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 un IoT Hub et un groupe de consommateurs Appareil à cloud	Ce modèle vous permet de déployer un IoT Hub instance avec des configurations de messagerie appareil-à-cloud et cloud-appareil et un groupe de consommateurs d’appareil à cloud.
Créer Device Update pour IoT Hub compte, instance IoT Hub	Ce modèle crée un compte, un instance et un hub pour lier les 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 Azure Health Data Services conçu pour ingérer des données d’appareil à partir de plusieurs appareils, transformer les données de l’appareil en observations FHIR, qui sont ensuite conservées dans le service FHIR Azure Health Data Services.
Créer un environnement de paiement à l’utilisation (PAYG) avec un IoT Hub	Ce modèle vous permet de déployer un environnement Pay As You Go (PAYG) Time Series Insights configuré pour consommer des événements à partir d’un IoT Hub.

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 des ressources

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"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      allowedFqdnList = [
        "string"
      ]
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
          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 = "Allow"
            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"
    }
    etag = "string"
  })
}

Valeurs de propriétés

IoTHubs

Nom	Description	Valeur
type	Type de ressource	« Microsoft.Devices/IotHubs@2023-06-30 »
name	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 3-50 Caractères valides : Caractères alphanumériques et traits d’union. Ne peut pas se terminer par un trait d’union. Le nom de la ressource doit être unique dans Azure.
location	Emplacement de la ressource.	chaîne (obligatoire)
parent_id	Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources.	chaîne (obligatoire)
tags	Étiquettes de la ressource.	Dictionnaire de noms et de valeurs d’étiquettes.
sku	Informations sur la référence SKU IotHub	IotHubSkuInfo (obligatoire)
etag	Le champ Etag n’est pas obligatoire. 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.	string
identité	Identités managées pour IotHub.	ArmIdentity
properties	Propriétés IotHub	IotHubProperties

ArmIdentity

Nom	Description	Valeur
type	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.	« SystemAssigned » « SystemAssigned, UserAssigned » « UserAssigned »
identity_ids	Dictionnaire de {ArmUserIdentity}	Tableau d’ID d’identité utilisateur.

ArmIdentityUserAssignedIdentities

Nom	Description	Valeur
{propriété personnalisée}		ArmUserIdentity

ArmUserIdentity

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

IotHubProperties

Nom	Description	Valeur
allowedFqdnList	Liste des noms de domaine complets (nom de domaine complet) autorisés pour la sortie à partir d’Iot Hub.	string[]
authorizationPolicies	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
comments	Commentaires IoT Hub.	string
disableDeviceSAS	Si la valeur est true, toutes les clés SAP étendues à l’ensemble des appareils (y compris les appareils Edge, mais à l’exclusion des modules) ne peuvent pas être utilisées pour l’authentification.	bool
disableLocalAuth	Si la valeur est true, les jetons SAP avec des clés SAS étendues au hub Iot 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, désactivant ainsi 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. Les seules clés possibles de ce dictionnaire sont les événements. Cette clé doit être présente dans le dictionnaire lors de la création ou de la mise à jour des appels pour le hub IoT.	IotHubPropertiesEventHubEndpoints
features	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 à 1.2 soient rejetés.	string
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	Si les demandes provenant du réseau public sont autorisées	« Désactivé » « Activé »
restrictOutboundNetworkAccess	Si la valeur est true, la sortie d’IotHub est limitée aux noms de domaine complets autorisés configurés via allowedFqdnList.	bool
routage	Propriétés liées au routage du hub IoT. Consultez : /azure/iot-hub/iot-hub-devguide-messaging	RoutingProperties
storageEndpoints	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.	IotHubPropertiesStorageEndpoints

SharedAccessSignatureAuthorizationRule

Nom	Description	Valeur
keyName	Nom de la stratégie d’accès partagé.	string (obligatoire)
primaryKey	Clé primaire.	string
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.	string
keyName	Nom de la stratégie d’accès partagé.	string (obligatoire)
primaryKey	Clé primaire.	string
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.	string

CloudToDeviceProperties

Nom	Description	Valeur
defaultTtlAsIso8601	Durée de vie par défaut des messages cloud-à-appareil dans la file d’attente de l’appareil. Consultez /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string
feedback	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 des appareils. Consultez /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	int Contraintes : Valeur minimale = 1 Valeur maximale = 100

FeedbackProperties

Nom	Description	Valeur
lockDurationAsIso8601	Durée de verrouillage de la file d’attente de commentaires. Consultez /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string
maxDeliveryCount	Nombre de fois que le hub IoT tente de remettre un message dans la file d’attente de commentaires. Consultez /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 peut être utilisé avant son expiration par le hub IoT. Consultez /azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.	string

IotHubPropertiesEventHubEndpoints

Nom	Description	Valeur
{propriété personnalisée}		EventHubProperties

EventHubProperties

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

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.	string (obligatoire)
ipMask	Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.	string (obligatoire)

IotHubPropertiesMessagingEndpoints

Nom	Description	Valeur
{propriété personnalisée}		MessagingEndpointProperties

MessagingEndpointProperties

Nom	Description	Valeur
lockDurationAsIso8601	Durée du verrou. Consultez : /azure/iot-hub/iot-hub-devguide-file-upload.	string
maxDeliveryCount	Nombre de tentatives de remise d’un message par le hub IoT. Consultez : /azure/iot-hub/iot-hub-devguide-file-upload.	int Contraintes : Valeur minimale = 1 Valeur maximale = 100
ttlAsIso8601	Période pendant laquelle un message peut être utilisé avant son expiration par le hub IoT. Consultez : /azure/iot-hub/iot-hub-devguide-file-upload.	string

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)

NetworkRuleSetIpRule

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

PrivateEndpointConnection

Nom	Description	Valeur
properties	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)

PrivateEndpoint

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

PrivateLinkServiceConnectionState

Nom	Description	Valeur
actionsRequired	Actions requises pour une connexion de point de terminaison privé	string
description	Description de l’état actuel d’une connexion de point de terminaison privé	string (obligatoire)
status	Status d’une connexion de point de terminaison privé	« Approuvé » « Déconnecté » « En attente » « Rejeté » (obligatoire)

RoutingProperties

Nom	Description	Valeur
points de terminaison	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.	RoutingEndpoints
enrichissements	Liste des enrichissements fournis par l’utilisateur que le hub IoT applique aux messages à remettre aux points de terminaison intégrés et personnalisés. Consultez : https://aka.ms/telemetryoneventgrid	EnrichmentProperties[]
fallbackRoute	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, 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 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.	RouteProperties[]

RoutingEndpoints

Nom	Description	Valeur
cosmosDBSqlContainers	Liste des points de terminaison de conteneur Cosmos DB auxquels 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 auxquels IoT Hub achemine les messages, en fonction des règles de routage.	RoutingStorageContainerProperties[]

RoutingCosmosDBSqlApiProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour l’authentification 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
name	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 : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques parmi les types de points de terminaison.	chaîne (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
partitionKeyName	Nom de la clé de partition associée à ce conteneur sql cosmos DB, le cas échéant. Il s'agit d'un paramètre facultatif.	string
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 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 les composants d’ordre et non réservé sont arbitraires. Ce paramètre n’est requis que si PartitionKeyName est spécifié.	string
primaryKey	Clé primaire du compte cosmos DB.	string Contraintes : Valeur sensible. Passez en tant que paramètre sécurisé.
resourceGroup	Nom du groupe de ressources du compte cosmos DB.	string
secondaryKey	Clé secondaire du compte cosmos DB.	string Contraintes : Valeur sensible. Passez en tant que paramètre sécurisé.
subscriptionId	Identificateur d’abonnement du compte cosmos DB.	string

ManagedIdentity

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

RoutingEventHubProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour l’authentification auprès du point de terminaison du hub d’événements	« identityBased » « keyBased »
connectionString	Chaîne de connexion du point de terminaison du hub d’événements.	string
endpointUri	URL du point de terminaison du hub d’événements. Il doit inclure le protocole sb://	string
entityPath	Nom du hub d’événements dans l’espace de noms du hub d’événements	string
id	ID du point de terminaison du hub d’événements	string
identité	Propriétés d’identité managée du point de terminaison du hub d’événements de routage.	ManagedIdentity
name	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 : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques parmi les types de points de terminaison.	chaîne (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nom du groupe de ressources du point de terminaison du hub d’événements.	string
subscriptionId	Identificateur d’abonnement du point de terminaison du hub d’événements.	string

RoutingServiceBusQueueEndpointProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour l’authentification 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.	string
endpointUri	URL du point de terminaison de file d’attente Service Bus. Il doit inclure le protocole sb://	string
entityPath	Nom de la file d’attente dans l’espace de noms Service Bus	string
id	ID du point de terminaison de file d’attente Service Bus	string
identité	Propriétés d’identité managée du point de terminaison de file d’attente service bus de routage.	ManagedIdentity
name	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.	string (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nom du groupe de ressources du point de terminaison de file d’attente Service Bus.	string
subscriptionId	Identificateur d’abonnement du point de terminaison de file d’attente Service Bus.	string

RoutingServiceBusTopicEndpointProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour l’authentification auprès du point de terminaison de rubrique Service Bus	« identityBased » « KeyBased »
connectionString	Chaîne de connexion du point de terminaison de la rubrique Service Bus.	string
endpointUri	URL du point de terminaison de la rubrique Service Bus. Il doit inclure le protocole sb://	string
entityPath	Nom de la file d’attente sur la rubrique Service Bus	string
id	ID du point de terminaison de la rubrique Service Bus	string
identité	Propriétés d’identité managée du point de terminaison de la rubrique Service Bus de routage.	ManagedIdentity
name	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.	string (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nom du groupe de ressources du point de terminaison de rubrique Service Bus.	string
subscriptionId	Identificateur d’abonnement du point de terminaison de la rubrique Service Bus.	string

RoutingStorageContainerProperties

Nom	Description	Valeur
authenticationType	Méthode utilisée pour l’authentification 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 300 secondes.	int Contraintes : Valeur minimale = 60 Valeur maximale = 720
connectionString	Chaîne de connexion du compte de stockage.	string
containerName	Nom du conteneur de stockage dans le compte de stockage.	string (obligatoire)
encodage	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 ».	« Avro » « AvroDeflate » « JSON »
endpointUri	URL du point de terminaison de stockage. Il doit inclure le protocole https://	string
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és.	string
id	ID du point de terminaison du conteneur de stockage	string
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
name	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 : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques parmi les types de points de terminaison.	chaîne (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
resourceGroup	Nom du groupe de ressources du compte de stockage.	string
subscriptionId	Identificateur d’abonnement du compte de stockage.	string

EnrichmentProperties

Nom	Description	Valeur
endpointNames	Liste des points de terminaison pour lesquels l’enrichissement est appliqué au message.	string[] (obligatoire) Contraintes : Longueur minimale = 1
key	Clé ou nom de la propriété d’enrichissement.	chaîne (obligatoire)
value	Valeur de la propriété d’enrichissement.	chaîne (obligatoire)

FallbackRouteProperties

Nom	Description	Valeur
condition	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 : /azure/iot-hub/iot-hub-devguide-query-language	string
endpointNames	Liste des points de terminaison vers lesquels les messages qui satisfont à la condition sont routés. Actuellement, un seul point de terminaison est autorisé.	string[] (obligatoire) Contraintes : Longueur minimale = 1 Longueur maximale = 1
isEnabled	Permet de spécifier si l’itinéraire de secours est activé.	bool (obligatoire)
name	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.	string
source	Source à laquelle la règle de routage doit être appliquée. Par exemple, DeviceMessages	« DeviceConnectionStateEvents » « DeviceJobLifecycleEvents » « DeviceLifecycleEvents » « DeviceMessages » « Non valide » « TwinChangeEvents » (obligatoire)

RouteProperties

Nom	Description	Valeur
condition	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 : /azure/iot-hub/iot-hub-devguide-query-language	string
endpointNames	Liste des points de terminaison vers lesquels les messages qui satisfont à la condition sont routés. Actuellement, un seul point de terminaison est autorisé.	string[] (obligatoire) Contraintes : Longueur minimale = 1 Longueur maximale = 1
isEnabled	Permet de spécifier si un itinéraire est activé.	bool (obligatoire)
name	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.	chaîne (obligatoire) Contraintes : Modèle = ^[A-Za-z0-9-._]{1,64}$
source	Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.	« DeviceConnectionStateEvents » « DeviceJobLifecycleEvents » « DeviceLifecycleEvents » « DeviceMessages » « Non valide » « TwinChangeEvents » (obligatoire)

IotHubPropertiesStorageEndpoints

Nom	Description	Valeur
{propriété personnalisée}		StorageEndpointProperties

StorageEndpointProperties

Nom	Description	Valeur
authenticationType	Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.	« identityBased » « keyBased »
connectionString	Le chaîne de connexion pour le compte stockage Azure sur 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 la connectionString spécifiée.	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. Consultez : /azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.	string

IotHubSkuInfo

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