Iot Hub Resource - Update

Service:: IoT Hub

Version d’API:: 2026-11-01

Mettre à jour des balises IoT Hubs existantes.
Mettre à jour des balises IoT Hub existantes. pour mettre à jour d’autres champs, utilisez la méthode CreateOrUpdate

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2026-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom n’est pas sensible à la casse.
resourceName	path	True	string	Nom du hub IoT.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
tags	object	Étiquettes de ressources

Réponses

Nom	Type	Description
200 OK	IotHubDescription	La demande a réussi. En-têtes Azure-AsyncOperation: string Location: string Retry-After: integer

Nom

Type

Description

200 OK

IotHubDescription

La demande a réussi.

En-têtes

Azure-AsyncOperation: string
Location: string
Retry-After: integer

Sécurité

azure_auth

Flux OAuth2 d’Azure Active Directory.

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

Étendues

Nom	Description
user_impersonation	Usurper l’identité de votre compte utilisateur

Exemples

IotHubResource_Update

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/myHub?api-version=2026-11-01

{
  "tags": {
    "foo": "bar"
  }
}

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
AccessRights	Autorisations affectées à la stratégie d’accès partagé.
ArmIdentity
ArmUserIdentity
AuthenticationType	Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.
Capabilities	Fonctionnalités et fonctionnalités activées pour le hub IoT.
CloudToDeviceProperties	Propriétés de messagerie cloud-à-appareil ioT Hub.
createdByType	Type d’identité qui a créé la ressource.
DefaultAction	Action par défaut pour l’ensemble de règles réseau
DeviceRegistry	Représente les propriétés liées au registre d’appareils Azure (ADR).
DeviceRegistryIdentity	Identité utilisée pour gérer l’espace de noms ADR à partir du plan de données.
DeviceRegistryIdentityType	Type de l’identité.
DeviceRegistryLinkingProperties	Les propriétés liées à la liaison de l’IoT Hub avec le Registre des Appareils Azure.
DeviceRegistryLinkingState	Indique si l’IoT Hub est lié à un registre Azure des appareils.
EnrichmentProperties	Propriétés d’un enrichissement que votre hub IoT applique aux messages remis aux points de terminaison.
ErrorDetails	Détails de l’erreur.
EventHubProperties	Propriétés du point de terminaison compatible avec Event Hub approvisionné utilisé par le hub IoT.
EventStreamAuthenticationType	Spécifie le type d’authentification utilisé pour se connecter au compte du flux d’événements.
FallbackRouteProperties	Les propriétés de l’itinéraire de secours. IoT Hub utilise ces propriétés lorsqu’il achemine les messages vers le point de terminaison de secours.
FallbackRouteSource	La source à laquelle la route de secours est appliquée.
FeedbackProperties	Propriétés de la file d’attente de commentaires pour les messages cloud-à-appareil.
GatewayVersion	La version IoT hub Gateway.
IotHubDescription	Description du hub IoT.
IotHubDetails	Ensemble de propriétés supplémentaires en lecture seule pour le hub IoT.
IotHubLocationDescription	Représentation publique de l’un des emplacements où une ressource est provisionnée.
IotHubProperties	Propriétés d’un hub IoT.
IotHubReplicaRoleType	Le rôle de la région peut être soit primaire, soit secondaire. La région primaire est celle où le hub IoT est actuellement approvisionné. La région secondaire est la région couplée à la récupération d’urgence Azure, ainsi que la région vers laquelle le hub IoT peut basculer.
IotHubSku	Nom de la référence SKU.
IotHubSkuInfo	Informations sur la référence SKU du hub IoT.
IotHubSkuTier	Niveau de facturation pour le hub IoT.
IpFilterActionType	Action souhaitée pour les demandes capturées par cette règle.
IpFilterRule	Règles de filtrage IP pour le hub IoT.
ManagedIdentity	Les propriétés de l’identité managée.
MessagingEndpointProperties	Propriétés des points de terminaison de messagerie utilisés par ce hub IoT.
NetworkRuleIPAction	Action de filtre IP
NetworkRuleSetIpRule	Règle IP à appliquer dans le cadre de l’ensemble de règles réseau
NetworkRuleSetProperties	Propriétés de l’ensemble de règles réseau d’IotHub
PrivateEndpoint	Propriété de point de terminaison privé d’une connexion de point de terminaison privé
PrivateEndpointConnection	La connexion de point de terminaison privé d’un IotHub
PrivateEndpointConnectionProperties	Propriétés d’une connexion de point de terminaison privé
PrivateLinkServiceConnectionState	État actuel d’une connexion de point de terminaison privé
PrivateLinkServiceConnectionStatus	État d’une connexion de point de terminaison privé
PublicNetworkAccess	Indique si les demandes du réseau public sont autorisées
ResourceIdentityType	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.
RouteProperties	Propriétés d’une règle de routage que votre hub IoT utilise pour acheminer les messages vers les points de terminaison.
RoutingCosmosDBSqlApiProperties	Propriétés liées à un point de terminaison de conteneur SQL cosmos DB.
RoutingEndpoints	Propriétés liées aux points de terminaison personnalisés auxquels votre hub IoT achemine les messages en fonction des règles de routage. Un maximum de 10 points de terminaison personnalisés sont autorisés sur tous les types de points de terminaison pour les hubs payants et un seul point de terminaison personnalisé est autorisé sur tous les types de points de terminaison pour les hubs gratuits.
RoutingEventHubProperties	Propriétés liées à un point de terminaison Event Hub.
RoutingEventStreamProperties	Les propriétés liées à un point de terminaison de flux d’événements.
RoutingProperties	Propriétés associées au routage du hub IoT. Consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Propriétés liées aux types de point de terminaison de file d’attente Service Bus.
RoutingServiceBusTopicEndpointProperties	Propriétés liées aux types de points de terminaison de rubrique Service Bus.
RoutingSource	Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.
RoutingStorageContainerProperties	Propriétés liées à un point de terminaison de conteneur de stockage.
RoutingStorageContainerPropertiesEncoding	Encodage utilisé pour sérialiser les messages vers des objets blob. Les valeurs prises en charge sont « avro », « avrodeflate » et « JSON ». La valeur par défaut est « avro ».
SharedAccessSignatureAuthorizationRule	Les propriétés d’une stratégie d’accès partagé IoT Hub.
StorageEndpointProperties	Les propriétés du point de terminaison de stockage Azure pour le chargement de fichiers.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TagsResource	Conteneur contenant uniquement les balises d’une ressource, permettant à l’utilisateur de mettre à jour les balises sur une instance IoT Hub.

AccessRights

Énumération

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

Valeur	Description
RegistryRead	RegistryRead
RegistryWrite	RegistryWrite
ServiceConnect	ServiceConnect
DeviceConnect	DeviceConnect
RegistryRead, RegistryWrite	RegistryRead, RegistryWrite
RegistryRead, ServiceConnect	RegistryRead, ServiceConnect
RegistryRead, DeviceConnect	RegistryRead, DeviceConnect
RegistryWrite, ServiceConnect	RegistryWrite, ServiceConnect
RegistryWrite, DeviceConnect	RegistryWrite, DeviceConnect
ServiceConnect, DeviceConnect	ServiceConnect, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect	RegistryRead, RegistryWrite, ServiceConnect
RegistryRead, RegistryWrite, DeviceConnect	RegistryRead, RegistryWrite, DeviceConnect
RegistryRead, ServiceConnect, DeviceConnect	RegistryRead, ServiceConnect, DeviceConnect
RegistryWrite, ServiceConnect, DeviceConnect	RegistryWrite, ServiceConnect, DeviceConnect
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect	RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

ArmIdentity

Objet

Nom	Type	Description
principalId	string	Numéro de directeur
tenantId	string	ID de locataire
type	ResourceIdentityType	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.
userAssignedIdentities	<string, ArmUserIdentity>	Dictionnaire de <> ArmUserIdentity

ArmUserIdentity

Objet

Nom	Type	Description
clientId	string
principalId	string

AuthenticationType

Énumération

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

Valeur	Description
keyBased	Basé sur des clés
identityBased	IdBased

Capabilities

Énumération

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

Valeur	Description
None	None
DeviceManagement	DeviceManagement

CloudToDeviceProperties

Objet

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

Nom	Type	Description
defaultTtlAsIso8601	string (duration)	Heure par défaut de vie des messages cloud-à-appareil dans la file d’attente de l’appareil. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
feedback	FeedbackProperties	Propriétés de la file d’attente de commentaires pour les messages cloud-à-appareil.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Nombre maximal de remises pour les messages cloud-à-appareil dans la file d’attente de l’appareil. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

createdByType

Énumération

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

Valeur	Description
User
Application
ManagedIdentity
Key

DefaultAction

Énumération

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

Valeur	Description
Deny	Deny
Allow	Autoriser

DeviceRegistry

Objet

Représente les propriétés liées au registre d’appareils Azure (ADR).

Nom	Type	Description
dataPlaneHostName	string	Le nom de l’hôte pour le point de terminaison du plan de données du registre Azure Device associé.
identity	DeviceRegistryIdentity	Identité utilisée pour gérer l’espace de noms ADR à partir du plan de données.
linkingProperties	DeviceRegistryLinkingProperties	Les propriétés liées à la liaison de l’IoT Hub avec le Registre des Appareils Azure.
namespaceResourceId	string (arm-id)	L’identifiant de l’espace de noms Azure Device Registry
namespaceUuid	string	L’UUID de l’espace de noms Azure Device Registry associé.

DeviceRegistryIdentity

Objet

Identité utilisée pour gérer l’espace de noms ADR à partir du plan de données.

Nom	Type	Description
type	DeviceRegistryIdentityType	Type de l’identité.
userAssignedIdentity	string (arm-id)	L’identité attribuée par l’utilisateur si le type d’identité est « UserAssigned ».

DeviceRegistryIdentityType

Énumération

Type de l’identité.

Valeur	Description
SystemAssigned	Utilisez une identité managée attribuée par le système pour gérer l’espace de noms ADR.
UserAssigned	Utilisez une identité managée attribuée par l’utilisateur pour gérer l’espace de noms ADR.

DeviceRegistryLinkingProperties

Objet

Les propriétés liées à la liaison de l’IoT Hub avec le Registre des Appareils Azure.

Nom	Type	Description
error	ErrorDetails	La dernière erreur rencontrée lors de la liaison de l’IoT Hub à un registre Azure Device Registry.
state	DeviceRegistryLinkingState	Indique si l’IoT Hub est lié à un registre Azure des appareils.

DeviceRegistryLinkingState

Énumération

Indique si l’IoT Hub est lié à un registre Azure des appareils.

Valeur	Description
InProgress	Le lien entre IoT Hub et un registre Azure Device est en cours.
Success	L’IoT Hub est relié avec succès à un registre Azure des appareils.
Orphaned	Le registre Azure Device Registry lié n’est plus associé à l’IoT Hub.
Failed	L’IoT Hub n’a pas réussi à se connecter à un registre Azure des appareils.

EnrichmentProperties

Objet

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

Nom	Type	Description
endpointNames	string[]	Liste des points de terminaison pour lesquels l’enrichissement est appliqué au message.
key	string	Clé ou nom de la propriété d’enrichissement.
value	string	Valeur de la propriété d’enrichissement.

ErrorDetails

Objet

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
details	string	Détails de l’erreur.
httpStatusCode	string	Code d’état HTTP.
message	string	Message d’erreur.

EventHubProperties

Objet

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

Nom	Type	Description
endpoint	string	Point de terminaison compatible Event Hub.
partitionCount	integer (int32)	Nombre de partitions pour la réception de messages appareil-à-cloud dans le point de terminaison compatible Event Hub. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
partitionIds	string[]	ID de partition dans le point de terminaison compatible avec Event Hub.
path	string	Nom compatible avec Event Hub.
retentionTimeInDays	integer (int64)	Durée de rétention des messages appareil-à-cloud en jours. Consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

EventStreamAuthenticationType

Énumération

Spécifie le type d’authentification utilisé pour se connecter au compte du flux d’événements.

Valeur	Description
identityBased	Authentification basée sur l’identité

FallbackRouteProperties

Objet

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

Nom	Type	Description
condition	string	Condition évaluée pour appliquer l’itinéraire de secours. Si la condition n’est pas fournie, elle prend la valeur true par défaut. Pour la grammaire, voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Liste des points de terminaison vers lesquels les messages qui répondent à la condition sont routés. Actuellement, seul 1 point de terminaison est autorisé.
isEnabled	boolean	Permet de spécifier si l’itinéraire de secours est activé.
name	string	Nom de l'itinéraire. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union, une longueur maximale de 64 caractères et doit être unique.
source	FallbackRouteSource	Source à laquelle la règle de routage doit être appliquée. Par exemple, DeviceMessages

FallbackRouteSource

Énumération

La source à laquelle la route de secours est appliquée.

Valeur	Description
DeviceMessages	Messages d’appareil vers le cloud envoyés par les appareils.

FeedbackProperties

Objet

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

Nom	Type	Description
lockDurationAsIso8601	string (duration)	Durée de verrouillage de la file d’attente de commentaires. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Nombre de tentatives de remise d’un message sur la file d’attente de commentaires par le hub IoT. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
ttlAsIso8601	string (duration)	Période pendant laquelle un message est disponible pour être consommé avant son expiration par le hub IoT. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

GatewayVersion

Énumération

La version IoT hub Gateway.

Valeur	Description
V1	V1
V2	V2

IotHubDescription

Objet

Description du hub IoT.

Nom	Type	Description
etag	string	Le champ Etag n’est pas requis. S’il est fourni dans le corps de la réponse, il doit également être fourni en tant qu’en-tête conformément à la convention ETag normale.
id	string (arm-id)	Identifiant de ressource entièrement qualifié pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
identity	ArmIdentity	Identités managées pour IotHub.
location	string	Emplacement géographique où réside la ressource
name	string	nom de la ressource.
properties	IotHubProperties	Propriétés IotHub
sku	IotHubSkuInfo	Informations sur la référence SKU IotHub
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressources.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

IotHubDetails

Objet

Ensemble de propriétés supplémentaires en lecture seule pour le hub IoT.

Nom	Type	Description
gatewayVersion	GatewayVersion	La version IoT hub Gateway.

IotHubLocationDescription

Objet

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

Nom	Type	Description
location	string	Nom de la région Azure
role	IotHubReplicaRoleType	Le rôle de la région peut être soit primaire, soit secondaire. La région primaire est celle où le hub IoT est actuellement approvisionné. La région secondaire est la région couplée à la récupération d’urgence Azure, ainsi que la région vers laquelle le hub IoT peut basculer.

IotHubProperties

Objet

Propriétés d’un hub IoT.

Nom	Type	Description
allowedFqdnList	string[]	Liste des noms de domaine complets autorisés (nom de domaine complet) pour la sortie à partir d’Iot Hub.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[]	Les stratégies d’accès partagé que vous pouvez utiliser pour sécuriser une connexion au hub IoT.
cloudToDevice	CloudToDeviceProperties	Propriétés de messagerie cloud-à-appareil ioT Hub.
comments	string	Commentaires ioT Hub.
deviceHostName	string	Le nom de l’hôte de l’appareil. Prend en charge les connexions sécurisées via TLS 1.3.
deviceRegistry	DeviceRegistry	Représente les propriétés liées au registre d’appareils Azure (ADR).
disableDeviceSAS	boolean	Si la valeur est true, tous les appareils (y compris les appareils Edge, mais à l’exclusion des modules) ne peuvent pas être utilisés pour l’authentification.
disableLocalAuth	boolean	Si la valeur est true, les jetons SAP avec des clés SAP étendues Iot hub ne peuvent pas être utilisés pour l’authentification.
disableModuleSAS	boolean	Si la valeur est true, toutes les clés SAP étendues au module ne peuvent pas être utilisées pour l’authentification.
enableDataResidency	boolean	Cette propriété lorsqu’elle est définie sur true active la résidence des données, ce qui désactive la récupération d’urgence.
enableFileUploadNotifications	boolean	Si la valeur est True, les notifications de chargement de fichiers sont activées.
eventHubEndpoints	<string, EventHubProperties>	Propriétés de point de terminaison compatibles avec Event Hub. La seule clé possible pour ce dictionnaire est les événements. Cette clé doit être présente dans le dictionnaire tout en effectuant des appels de création ou de mise à jour pour le hub IoT.
features	Capabilities	Fonctionnalités et fonctionnalités activées pour le hub IoT.
hostName	string	Nom de l’hôte.
iotHubDetails	IotHubDetails	Ensemble de propriétés supplémentaires en lecture seule pour le hub IoT.
ipFilterRules	IpFilterRule[]	Règles de filtre IP.
locations	IotHubLocationDescription[]	Emplacement principal et secondaire pour iot Hub
messagingEndpoints	<string, MessagingEndpointProperties>	Propriétés du point de terminaison de messagerie pour la file d’attente de notification de chargement de fichier.
minTlsVersion	string	Spécifie la version TLS minimale à prendre en charge pour ce hub. Peut être défini sur « 1.2 » pour que les clients qui utilisent une version TLS inférieure à la version 1.2 soient rejetés.
networkRuleSets	NetworkRuleSetProperties	Propriétés de l’ensemble de règles réseau d’IotHub
privateEndpointConnections	PrivateEndpointConnection[]	Connexions de point de terminaison privé créées sur cet IotHub
provisioningState	string	État d’approvisionnement.
publicNetworkAccess	PublicNetworkAccess	Indique si les demandes du réseau public sont autorisées
restrictOutboundNetworkAccess	boolean	Si la valeur est true, la sortie d’IotHub est limitée uniquement aux noms de domaine complets autorisés configurés via allowedFqdnList.
routing	RoutingProperties	Propriétés associées au routage du hub IoT. Consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
serviceHostName	string	Le nom de l’hôte du service. Prend en charge les connexions sécurisées via TLS 1.3.
state	string	L’état de la centrale.
storageEndpoints	<string, StorageEndpointProperties>	Liste des points de terminaison stockage Azure où vous pouvez charger des fichiers. Actuellement, vous ne pouvez configurer qu’un seul compte stockage Azure et qui doit avoir sa clé comme $default. La spécification de plusieurs comptes de stockage provoque la levée d’une erreur. Si vous ne spécifiez pas de valeur pour cette propriété lorsque la propriété enableFileUploadNotifications a la valeur True, une erreur est générée.

IotHubReplicaRoleType

Énumération

Le rôle de la région peut être soit primaire, soit secondaire. La région primaire est celle où le hub IoT est actuellement approvisionné. La région secondaire est la région couplée à la récupération d’urgence Azure, ainsi que la région vers laquelle le hub IoT peut basculer.

Valeur	Description
primary	primaire
secondary	secondary

IotHubSku

Énumération

Nom de la référence SKU.

Valeur	Description
F1	F1
S1	S1
S2	S2
S3	S3
B1	B1
B2	B2
B3	B3

IotHubSkuInfo

Objet

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

Nom	Type	Description
capacity	integer (int64)	Nombre d’unités IoT Hub approvisionnées. Voir : https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name	IotHubSku	Nom de la référence SKU.
tier	IotHubSkuTier	Niveau de facturation pour le hub IoT.

IotHubSkuTier

Énumération

Niveau de facturation pour le hub IoT.

Valeur	Description
Free	Gratuit
Standard	Standard
Basic	Basic

IpFilterActionType

Énumération

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

Valeur	Description
Accept	Accepter
Reject	Rejeter

IpFilterRule

Objet

Règles de filtrage IP pour le hub IoT.

Nom	Type	Description
action	IpFilterActionType	Action souhaitée pour les demandes capturées par cette règle.
filterName	string	Nom de la règle de filtre IP.
ipMask	string	Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.

ManagedIdentity

Objet

Les propriétés de l’identité managée.

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

MessagingEndpointProperties

Objet

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

Nom	Type	Description
lockDurationAsIso8601	string (duration)	Durée du verrou. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
maxDeliveryCount	integer (int32) minimum: 1 maximum: 100	Nombre de tentatives de remise d’un message par le hub IoT. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
ttlAsIso8601	string (duration)	Période pendant laquelle un message est disponible pour être consommé avant son expiration par le hub IoT. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.

NetworkRuleIPAction

Énumération

Action de filtre IP

Valeur	Description
Allow	Autoriser

NetworkRuleSetIpRule

Objet

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

Nom	Type	Valeur par défaut	Description
action	NetworkRuleIPAction	Allow	Action de filtre IP
filterName	string		Nom de la règle de filtre IP.
ipMask	string		Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.

NetworkRuleSetProperties

Objet

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

Nom	Type	Valeur par défaut	Description
applyToBuiltInEventHubEndpoint	boolean		Si la valeur est True, l’ensemble de règles réseau est également appliqué à BuiltIn EventHub EndPoint d’IotHub
defaultAction	DefaultAction	Deny	Action par défaut pour l’ensemble de règles réseau
ipRules	NetworkRuleSetIpRule[]		Liste des règles IP

PrivateEndpoint

Objet

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

Nom	Type	Description
id	string	Identificateur de ressource.

PrivateEndpointConnection

Objet

La connexion de point de terminaison privé d’un IotHub

Nom	Type	Description
id	string (arm-id)	Identifiant de ressource entièrement qualifié pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	nom de la ressource.
properties	PrivateEndpointConnectionProperties	Propriétés d’une connexion de point de terminaison privé
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointConnectionProperties

Objet

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

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

PrivateLinkServiceConnectionState

Objet

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

Nom	Type	Description
actionsRequired	string	Actions requises pour une connexion de point de terminaison privé
description	string	Description de l’état actuel d’une connexion de point de terminaison privé
status	PrivateLinkServiceConnectionStatus	État d’une connexion de point de terminaison privé

PrivateLinkServiceConnectionStatus

Énumération

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

Valeur	Description
Pending	Pending
Approved	Approuvée
Rejected	Rejected
Disconnected	Déconnecté

PublicNetworkAccess

Énumération

Indique si les demandes du réseau public sont autorisées

Valeur	Description
Enabled	Enabled
Disabled	Disabled

ResourceIdentityType

Énumération

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

Valeur	Description
SystemAssigned	Attribué par le système
UserAssigned	UserAssigned
SystemAssigned, UserAssigned	SystemAssigned, UserAssigned
None	None

RouteProperties

Objet

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

Nom	Type	Description
condition	string	Condition évaluée pour appliquer la règle de routage. Si aucune condition n’est fournie, elle prend la valeur true par défaut. Pour la grammaire, voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
endpointNames	string[]	Liste des points de terminaison vers lesquels les messages qui répondent à la condition sont routés. Actuellement, un seul point de terminaison est autorisé.
isEnabled	boolean	Permet de spécifier si un itinéraire est activé.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nom de l'itinéraire. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union, une longueur maximale de 64 caractères et doit être unique.
source	RoutingSource	Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages.

RoutingCosmosDBSqlApiProperties

Objet

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

Nom	Type	Description
authenticationType	AuthenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de conteneur sql cosmos DB
containerName	string	Nom du conteneur sql cosmos DB dans la base de données Cosmos DB.
databaseName	string	Nom de la base de données cosmos DB dans le compte cosmos DB.
endpointUri	string (uri)	URL du compte cosmos DB. Il doit inclure le protocole https://
id	string	ID du point de terminaison de conteneur sql cosmos DB
identity	ManagedIdentity	Propriétés d’identité managée du point de terminaison de conteneur cosmos DB de routage.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.
partitionKeyName	string	Nom de la clé de partition associée à ce conteneur sql cosmos DB s’il en existe un. Il s’agit d’un paramètre facultatif.
partitionKeyTemplate	string	Modèle de génération d’une valeur de clé de partition synthétique à utiliser avec ce conteneur sql cosmos DB. Le modèle doit inclure au moins l’un des espaces réservés suivants : {iothub}, {deviceid}, {DD}, {MM}et {AAAA}. Tous les espaces réservés peuvent être spécifiés au maximum une fois, mais les composants de commande et non-espace réservé sont arbitraires. Ce paramètre est obligatoire uniquement si PartitionKeyName est spécifié.
primaryKey	string (password)	Clé primaire du compte Cosmos DB.
resourceGroup	string	Nom du groupe de ressources du compte cosmos DB.
secondaryKey	string (password)	Clé secondaire du compte Cosmos DB.
subscriptionId	string	Identificateur d’abonnement du compte Cosmos DB.

RoutingEndpoints

Objet

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

Nom	Type	Description
cosmosDBSqlContainers	RoutingCosmosDBSqlApiProperties[]	La liste des points de terminaison de conteneur Cosmos DB vers utilisant IoT Hub achemine les messages en fonction des règles de routage.
eventHubs	RoutingEventHubProperties[]	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é.
eventStreams	RoutingEventStreamProperties[]	La liste des points de terminaison du flux d’événements vers lesquels le hub IoT aligne les messages, basée sur les règles de routage.
serviceBusQueues	RoutingServiceBusQueueEndpointProperties[]	Liste des points de terminaison de file d’attente Service Bus auxquels IoT Hub achemine les messages en fonction des règles de routage.
serviceBusTopics	RoutingServiceBusTopicEndpointProperties[]	Liste des points de terminaison de rubrique Service Bus auxquels le hub IoT achemine les messages en fonction des règles de routage.
storageContainers	RoutingStorageContainerProperties[]	Liste des points de terminaison de conteneur de stockage vers utilisant ioT Hub qui acheminent les messages en fonction des règles de routage.

RoutingEventHubProperties

Objet

Propriétés liées à un point de terminaison Event Hub.

Nom	Type	Description
authenticationType	AuthenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison event Hub
connectionString	string (password)	Chaîne de connexion du point de terminaison event Hub.
endpointUri	string	URL du point de terminaison event Hub. Il doit inclure le protocole sb://
entityPath	string	Nom du hub d’événements sur l’espace de noms du hub d’événements
id	string	ID du point de terminaison du hub d’événements
identity	ManagedIdentity	Propriétés d’identité managée du point de terminaison event Hub de routage.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.
resourceGroup	string	Nom du groupe de ressources du point de terminaison event Hub.
subscriptionId	string	Identificateur d’abonnement du point de terminaison event Hub.

RoutingEventStreamProperties

Objet

Les propriétés liées à un point de terminaison de flux d’événements.

Nom	Type	Description
authenticationType	EventStreamAuthenticationType	Méthode utilisée pour authentifier par rapport au point de terminaison du flux d’événements
endpointUri	string	L’URL de l’espace de noms du hub d’événements sous-jacent du point de terminaison du flux d’événements. Il doit inclure le protocole sb://
entityPath	string	Nom du hub d’événements sur l’espace de noms du hub d’événements
eventStreamId	string	Le GUID unique du flux d’événements cible sous l’espace de travail.
id	string	Id du point de terminaison du flux d’événements
identity	ManagedIdentity	Propriétés d’identité gérées du point de terminaison du flux d’événements de routage.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.
sourceId	string	Le GUID unique de la source personnalisée pour le flux d’événements.
workspaceId	string	Le GUID unique de l’espace de travail Microsoft Fabric cible pour le point de terminaison du flux d’événements.

RoutingProperties

Objet

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

Nom	Type	Description
endpoints	RoutingEndpoints	Propriétés liées aux points de terminaison personnalisés auxquels votre hub IoT achemine les messages en fonction des règles de routage. Un maximum de 10 points de terminaison personnalisés sont autorisés sur tous les types de points de terminaison pour les hubs payants et un seul point de terminaison personnalisé est autorisé sur tous les types de points de terminaison pour les hubs gratuits.
enrichments	EnrichmentProperties[]	Liste des enrichissements fournis par l’utilisateur que le hub IoT s’applique aux messages à remettre aux points de terminaison intégrés et personnalisés. Consultez : https://aka.ms/telemetryoneventgrid
fallbackRoute	FallbackRouteProperties	Propriétés de l’itinéraire utilisé comme itinéraire de secours quand aucune des conditions spécifiées dans la section « routes » n’est remplie. Il s’agit d’un paramètre facultatif. Lorsque cette propriété n’est pas définie, les messages qui ne remplissent aucune des conditions spécifiées dans la section « routes » sont acheminés vers le point de terminaison eventhub intégré.
routes	RouteProperties[]	Liste des règles de routage fournies par l’utilisateur que le hub IoT utilise pour router les messages vers des points de terminaison intégrés et personnalisés. Un maximum de 100 règles de routage sont autorisées pour les hubs payants et un maximum de 5 règles de routage sont autorisées pour les hubs gratuits.

RoutingServiceBusQueueEndpointProperties

Objet

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

Nom	Type	Description
authenticationType	AuthenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de file d’attente Service Bus
connectionString	string (password)	Chaîne de connexion du point de terminaison de file d’attente Service Bus.
endpointUri	string	URL du point de terminaison de file d’attente Service Bus. Il doit inclure le protocole sb://
entityPath	string	Nom de la file d’attente sur l’espace de noms Service Bus
id	string	ID du point de terminaison de file d’attente Service Bus
identity	ManagedIdentity	Propriétés d’identité managée du point de terminaison de file d’attente service bus de routage.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison. Le nom n’a pas besoin d’être identique au nom de file d’attente réel.
resourceGroup	string	Nom du groupe de ressources du point de terminaison de file d’attente Service Bus.
subscriptionId	string	Identificateur d’abonnement du point de terminaison de file d’attente Service Bus.

RoutingServiceBusTopicEndpointProperties

Objet

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

Nom	Type	Description
authenticationType	AuthenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de rubrique Service Bus
connectionString	string (password)	Chaîne de connexion du point de terminaison de rubrique Service Bus.
endpointUri	string	URL du point de terminaison de rubrique Service Bus. Il doit inclure le protocole sb://
entityPath	string	Nom de la file d’attente dans la rubrique Service Bus
id	string	ID du point de terminaison de rubrique Service Bus
identity	ManagedIdentity	Propriétés d’identité managée du point de terminaison de rubrique Service Bus de routage.
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison. Le nom n’a pas besoin d’être identique au nom de la rubrique réelle.
resourceGroup	string	Nom du groupe de ressources du point de terminaison de rubrique Service Bus.
subscriptionId	string	Identificateur d’abonnement du point de terminaison de rubrique Service Bus.

RoutingSource

Énumération

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

Valeur	Description
Invalid	Non valide
DeviceMessages	DeviceMessages
TwinChangeEvents	TwinChangeEvents
DeviceLifecycleEvents	ÉvénementsDuCycleDeVieDuDispositif
DeviceJobLifecycleEvents	DeviceJobLifecycleEvents
DeviceConnectionStateEvents	DeviceConnectionStateEvents

RoutingStorageContainerProperties

Objet

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

Nom	Type	Description
authenticationType	AuthenticationType	Méthode utilisée pour s’authentifier auprès du point de terminaison de stockage
batchFrequencyInSeconds	integer (int32) minimum: 60 maximum: 720	Intervalle de temps auquel les objets blob sont écrits dans le stockage. La valeur doit être comprise entre 60 et 720 secondes. La valeur par défaut est de 300 secondes.
connectionString	string (password)	Chaîne de connexion du compte de stockage.
containerName	string	Nom du conteneur de stockage dans le compte de stockage.
encoding	RoutingStorageContainerPropertiesEncoding	Encodage utilisé pour sérialiser les messages vers des objets blob. Les valeurs prises en charge sont « avro », « avrodeflate » et « JSON ». La valeur par défaut est « avro ».
endpointUri	string	URL du point de terminaison de stockage. Il doit inclure le protocole https://
fileNameFormat	string	Format de nom de fichier pour l’objet blob. Le format par défaut est {iothub}/{partition}/{AAAA}/{MM}/{DD}/{HH}/{mm}. Tous les paramètres sont obligatoires, mais peuvent être réorganisé.
id	string	ID du point de terminaison du conteneur de stockage
identity	ManagedIdentity	Propriétés d’identité managée du point de terminaison de stockage de routage.
maxChunkSizeInBytes	integer (int32) minimum: 10485760 maximum: 524288000	Nombre maximal d’octets pour chaque objet blob écrit dans le stockage. La valeur doit être comprise entre 10485760(10 Mo) et 524288000(500 Mo). La valeur par défaut est 314572800(300 Mo).
name	string pattern: ^[A-Za-z0-9-._]{1,64}$	Nom qui identifie ce point de terminaison. Le nom ne peut inclure que des caractères alphanumériques, des points, des traits de soulignement, des traits d’union et une longueur maximale de 64 caractères. Les noms suivants sont réservés : événements, fileNotifications, $default. Les noms de points de terminaison doivent être uniques entre les types de points de terminaison.
resourceGroup	string	Nom du groupe de ressources du compte de stockage.
subscriptionId	string	Identificateur d’abonnement du compte de stockage.

RoutingStorageContainerPropertiesEncoding

Énumération

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

Valeur	Description
Avro	Avro
AvroDeflate	AvroDeflate
JSON	JSON

SharedAccessSignatureAuthorizationRule

Objet

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

Nom	Type	Description
keyName	string	Nom de la stratégie d’accès partagé.
primaryKey	string	Clé primaire.
rights	AccessRights	Autorisations affectées à la stratégie d’accès partagé.
secondaryKey	string	Clé secondaire.

StorageEndpointProperties

Objet

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

Nom	Type	Description
authenticationType	AuthenticationType	Spécifie le type d’authentification utilisé pour la connexion au compte de stockage.
connectionString	string	Chaîne de connexion pour le compte stockage Azure vers lequel les fichiers sont chargés.
containerName	string	Nom du conteneur racine dans lequel vous chargez des fichiers. Le conteneur n’a pas besoin d’exister, mais doit être créatable à l’aide de connectionString spécifié.
identity	ManagedIdentity	Propriétés d’identité managée du point de terminaison de stockage pour le chargement de fichiers.
sasTtlAsIso8601	string (duration)	Période pendant laquelle l’URI SAP généré par IoT Hub pour le chargement de fichiers est valide. Voir : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.

systemData

Objet

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

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

TagsResource

Objet

Conteneur contenant uniquement les balises d’une ressource, permettant à l’utilisateur de mettre à jour les balises sur une instance IoT Hub.

Nom	Type	Description
tags	object	Étiquettes de ressources