@azure/arm-iothub package

Classes

IotHubClient

Interfaces

ArmIdentity
ArmUserIdentity
CertificateBodyDescription	Certificat X509 sérialisé JSON.
CertificateDescription	Certificat X509.
CertificateListDescription	Tableau sérialisé JSON d’objets Certificate.
CertificateProperties	Description d’un certificat d’autorité de certification X509.
CertificatePropertiesWithNonce	Description d’un certificat d’autorité de certification X509, y compris le nonce de défi émis pour le flux de preuve de possession.
CertificateVerificationDescription	Certificat feuille sérialisé JSON
CertificateWithNonceDescription	Certificat X509.
Certificates	Interface représentant des certificats.
CertificatesCreateOrUpdateOptionalParams	Paramètres facultatifs.
CertificatesDeleteOptionalParams	Paramètres facultatifs.
CertificatesGenerateVerificationCodeOptionalParams	Paramètres facultatifs.
CertificatesGetOptionalParams	Paramètres facultatifs.
CertificatesListByIotHubOptionalParams	Paramètres facultatifs.
CertificatesVerifyOptionalParams	Paramètres facultatifs.
CloudToDeviceProperties	Propriétés de messagerie cloud-à-appareil IoT Hub.
EndpointHealthData	Données d’intégrité d’un point de terminaison
EndpointHealthDataListResult	Tableau sérialisé JSON d’objets EndpointHealthData avec un lien suivant.
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.
EventHubConsumerGroupBodyDescription	Groupe de consommateurs EventHub.
EventHubConsumerGroupInfo	Propriétés de l’objet EventHubConsumerGroupInfo.
EventHubConsumerGroupName	Nom du groupe de consommateurs EventHub.
EventHubConsumerGroupsListResult	Tableau sérialisé JSON de noms de groupes de consommateurs compatibles avec Event Hub avec un lien suivant.
EventHubProperties	Propriétés du point de terminaison compatible Event Hub provisionné utilisé par le hub IoT.
ExportDevicesRequest	Permet de fournir des paramètres lors de la demande d’exportation de tous les appareils dans le hub IoT.
FailoverInput	Permet de fournir une région de basculement lors de la demande de basculement manuel pour un hub.
FallbackRouteProperties	Propriétés de l’itinéraire de secours. IoT Hub utilise ces propriétés lorsqu’il achemine les messages vers le point de terminaison de secours.
FeedbackProperties	Propriétés de la file d’attente de commentaires pour les messages cloud-à-appareil.
GroupIdInformation	Informations de groupe pour la création d’un point de terminaison privé sur un IotHub
GroupIdInformationProperties	Propriétés d’un objet d’informations de groupe
ImportDevicesRequest	Utilisez pour fournir des paramètres lors de la demande d’importation de tous les appareils dans le hub.
IotHub	Interface représentant un IotHub.
IotHubCapacity	IoT Hub informations sur la capacité.
IotHubClientOptionalParams	Paramètres facultatifs.
IotHubDescription	Description du hub IoT.
IotHubDescriptionListResult	Tableau sérialisé JSON d’objets IotHubDescription avec un lien suivant.
IotHubLocationDescription	Représentation publique de l’un des emplacements où une ressource est provisionnée.
IotHubManualFailoverHeaders	Définit des en-têtes pour IotHub_manualFailover opération.
IotHubManualFailoverOptionalParams	Paramètres facultatifs.
IotHubNameAvailabilityInfo	Propriétés indiquant si un nom de hub IoT donné est disponible.
IotHubProperties	Propriétés d’un hub IoT.
IotHubQuotaMetricInfo	Propriétés des métriques de quota.
IotHubQuotaMetricInfoListResult	Tableau sérialisé JSON d’objets IotHubQuotaMetricInfo avec un lien suivant.
IotHubResource	Interface représentant un IotHubResource.
IotHubResourceCheckNameAvailabilityOptionalParams	Paramètres facultatifs.
IotHubResourceCreateEventHubConsumerGroupOptionalParams	Paramètres facultatifs.
IotHubResourceCreateOrUpdateOptionalParams	Paramètres facultatifs.
IotHubResourceDeleteEventHubConsumerGroupOptionalParams	Paramètres facultatifs.
IotHubResourceDeleteHeaders	Définit des en-têtes pour IotHubResource_delete opération.
IotHubResourceDeleteOptionalParams	Paramètres facultatifs.
IotHubResourceExportDevicesOptionalParams	Paramètres facultatifs.
IotHubResourceGetEndpointHealthNextOptionalParams	Paramètres facultatifs.
IotHubResourceGetEndpointHealthOptionalParams	Paramètres facultatifs.
IotHubResourceGetEventHubConsumerGroupOptionalParams	Paramètres facultatifs.
IotHubResourceGetJobOptionalParams	Paramètres facultatifs.
IotHubResourceGetKeysForKeyNameOptionalParams	Paramètres facultatifs.
IotHubResourceGetOptionalParams	Paramètres facultatifs.
IotHubResourceGetQuotaMetricsNextOptionalParams	Paramètres facultatifs.
IotHubResourceGetQuotaMetricsOptionalParams	Paramètres facultatifs.
IotHubResourceGetStatsOptionalParams	Paramètres facultatifs.
IotHubResourceGetValidSkusNextOptionalParams	Paramètres facultatifs.
IotHubResourceGetValidSkusOptionalParams	Paramètres facultatifs.
IotHubResourceImportDevicesOptionalParams	Paramètres facultatifs.
IotHubResourceListByResourceGroupNextOptionalParams	Paramètres facultatifs.
IotHubResourceListByResourceGroupOptionalParams	Paramètres facultatifs.
IotHubResourceListBySubscriptionNextOptionalParams	Paramètres facultatifs.
IotHubResourceListBySubscriptionOptionalParams	Paramètres facultatifs.
IotHubResourceListEventHubConsumerGroupsNextOptionalParams	Paramètres facultatifs.
IotHubResourceListEventHubConsumerGroupsOptionalParams	Paramètres facultatifs.
IotHubResourceListJobsNextOptionalParams	Paramètres facultatifs.
IotHubResourceListJobsOptionalParams	Paramètres facultatifs.
IotHubResourceListKeysNextOptionalParams	Paramètres facultatifs.
IotHubResourceListKeysOptionalParams	Paramètres facultatifs.
IotHubResourceTestAllRoutesOptionalParams	Paramètres facultatifs.
IotHubResourceTestRouteOptionalParams	Paramètres facultatifs.
IotHubResourceUpdateOptionalParams	Paramètres facultatifs.
IotHubSkuDescription	Propriétés de la référence SKU.
IotHubSkuDescriptionListResult	Tableau sérialisé JSON d’objets IotHubSkuDescription avec un lien suivant.
IotHubSkuInfo	Informations sur la référence SKU du hub IoT.
IpFilterRule	Règles de filtre IP pour le hub IoT.
JobResponse	Propriétés de l’objet Job Response.
JobResponseListResult	Tableau sérialisé JSON d’objets JobResponse avec un lien suivant.
ManagedIdentity	Propriétés de l’identité managée.
MatchedRoute	Itinéraires correspondants
MessagingEndpointProperties	Propriétés des points de terminaison de messagerie utilisés par ce hub IoT.
Name	Nom du type Iot Hub
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
Operation	IoT Hub opération d’API REST
OperationDisplay	Objet qui représente l’opération.
OperationInputs	Valeurs d’entrée.
OperationListResult	Résultat de la demande de liste des opérations de IoT Hub. Il contient une liste d’opérations et un lien d’URL pour obtenir l’ensemble de résultats suivant.
Operations	Interface représentant une opération.
OperationsListNextOptionalParams	Paramètres facultatifs.
OperationsListOptionalParams	Paramètres facultatifs.
PrivateEndpoint	Propriété de point de terminaison privé d’une connexion de point de terminaison privé
PrivateEndpointConnection	Connexion de point de terminaison privé d’un IotHub
PrivateEndpointConnectionProperties	Propriétés d’une connexion de point de terminaison privé
PrivateEndpointConnections	Interface représentant un PrivateEndpointConnections.
PrivateEndpointConnectionsDeleteHeaders	Définit des en-têtes pour PrivateEndpointConnections_delete opération.
PrivateEndpointConnectionsDeleteOptionalParams	Paramètres facultatifs.
PrivateEndpointConnectionsGetOptionalParams	Paramètres facultatifs.
PrivateEndpointConnectionsListOptionalParams	Paramètres facultatifs.
PrivateEndpointConnectionsUpdateOptionalParams	Paramètres facultatifs.
PrivateLinkResources	Ressources de liaison privée disponibles pour un IotHub
PrivateLinkResourcesGetOptionalParams	Paramètres facultatifs.
PrivateLinkResourcesListOptionalParams	Paramètres facultatifs.
PrivateLinkResourcesOperations	Interface représentant un PrivateLinkResourcesOperations.
PrivateLinkServiceConnectionState	État actuel d’une connexion de point de terminaison privé
RegistryStatistics	Statistiques du registre d’identités.
Resource	Propriétés courantes d’une ressource Azure.
ResourceProviderCommon	Interface représentant un ResourceProviderCommon.
ResourceProviderCommonGetSubscriptionQuotaOptionalParams	Paramètres facultatifs.
RouteCompilationError	Erreur de compilation lors de l’évaluation de l’itinéraire
RouteErrorPosition	Position à l’emplacement où l’erreur de routage s’est produite
RouteErrorRange	Plage d’erreurs de routage
RouteProperties	Propriétés d’une règle de routage que votre hub IoT utilise pour acheminer les messages vers les points de terminaison.
RoutingCosmosDBSqlApiProperties	Propriétés liées à un point de terminaison de conteneur sql cosmos DB.
RoutingEndpoints	Propriétés liées aux points de terminaison personnalisés vers lesquels votre hub IoT achemine les messages en fonction des règles de routage. Un maximum de 10 points de terminaison personnalisés sont autorisés pour tous les types de points de terminaison pour les hubs payants et un seul point de terminaison personnalisé est autorisé sur tous les types de points de terminaison pour les hubs gratuits.
RoutingEventHubProperties	Propriétés liées à un point de terminaison de hub d’événements.
RoutingMessage	Message de routage
RoutingProperties	Propriétés liées au routage du hub IoT. Consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Propriétés liées aux types de points de terminaison de file d’attente Service Bus.
RoutingServiceBusTopicEndpointProperties	Propriétés liées aux types de points de terminaison de rubrique Service Bus.
RoutingStorageContainerProperties	Propriétés liées à un point de terminaison de conteneur de stockage.
RoutingTwin	Paramètre d’entrée de référence de jumeau. Il s’agit d’un paramètre facultatif
RoutingTwinProperties
SharedAccessSignatureAuthorizationRule	Propriétés d’une stratégie d’accès partagé IoT Hub.
SharedAccessSignatureAuthorizationRuleListResult	Liste des stratégies d’accès partagé avec un lien suivant.
StorageEndpointProperties	Propriétés du point de terminaison stockage Azure pour le chargement de fichiers.
SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TagsResource	Conteneur contenant uniquement les balises d’une ressource, ce qui permet à l’utilisateur de mettre à jour les balises sur un IoT Hub instance.
TestAllRoutesInput	Entrée pour tester tous les itinéraires
TestAllRoutesResult	Résultat du test de tous les itinéraires
TestRouteInput	Entrée pour tester l’itinéraire
TestRouteResult	Résultat du test d’une route
TestRouteResultDetails	Résultat détaillé du test d’un itinéraire
UserSubscriptionQuota	Réponse au quota d’abonnement utilisateur
UserSubscriptionQuotaListResult	Tableau sérialisé json de réponse au quota d’abonnement utilisateur

Alias de type

AccessRights	Définit des valeurs pour AccessRights.
AuthenticationType	Définit des valeurs pour AuthenticationType. KnownAuthenticationType peut être utilisé indifféremment avec AuthenticationType. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service keyBased identityBased
Capabilities	Définit des valeurs pour Capabilities. KnownCapabilities peut être utilisé indifféremment avec Capabilities. Cette énumération contient les valeurs connues prises en charge par le service. Valeurs connues prises en charge par le service Aucun DeviceManagement
CertificatesCreateOrUpdateResponse	Contient des données de réponse pour l’opération createOrUpdate.
CertificatesGenerateVerificationCodeResponse	Contient des données de réponse pour l’opération generateVerificationCode.
CertificatesGetResponse	Contient des données de réponse pour l’opération get.
CertificatesListByIotHubResponse	Contient des données de réponse pour l’opération listByIotHub.
CertificatesVerifyResponse	Contient des données de réponse pour l’opération de vérification.
CreatedByType	Définit des valeurs pour CreatedByType. KnownCreatedByType peut être utilisé indifféremment avec CreatedByType. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Utilisateur Application ManagedIdentity Clé
DefaultAction	Définit des valeurs pour DefaultAction. KnownDefaultAction peut être utilisé indifféremment avec DefaultAction. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Deny Autoriser
EndpointHealthStatus	Définit des valeurs pour EndpointHealthStatus. KnownEndpointHealthStatus peut être utilisé indifféremment avec EndpointHealthStatus. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service unknown Sain Dégradé Malsain dead
IotHubNameUnavailabilityReason	Définit des valeurs pour IotHubNameUnavailabilityReason.
IotHubReplicaRoleType	Définit des valeurs pour IotHubReplicaRoleType. KnownIotHubReplicaRoleType peut être utilisé indifféremment avec IotHubReplicaRoleType. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Primaire Secondaire
IotHubResourceCheckNameAvailabilityResponse	Contient des données de réponse pour l’opération checkNameAvailability.
IotHubResourceCreateEventHubConsumerGroupResponse	Contient des données de réponse pour l’opération createEventHubConsumerGroup.
IotHubResourceCreateOrUpdateResponse	Contient des données de réponse pour l’opération createOrUpdate.
IotHubResourceDeleteResponse	Contient des données de réponse pour l’opération de suppression.
IotHubResourceExportDevicesResponse	Contient des données de réponse pour l’opération exportDevices.
IotHubResourceGetEndpointHealthNextResponse	Contient des données de réponse pour l’opération getEndpointHealthNext.
IotHubResourceGetEndpointHealthResponse	Contient des données de réponse pour l’opération getEndpointHealth.
IotHubResourceGetEventHubConsumerGroupResponse	Contient des données de réponse pour l’opération getEventHubConsumerGroup.
IotHubResourceGetJobResponse	Contient des données de réponse pour l’opération getJob.
IotHubResourceGetKeysForKeyNameResponse	Contient des données de réponse pour l’opération getKeysForKeyName.
IotHubResourceGetQuotaMetricsNextResponse	Contient des données de réponse pour l’opération getQuotaMetricsNext.
IotHubResourceGetQuotaMetricsResponse	Contient des données de réponse pour l’opération getQuotaMetrics.
IotHubResourceGetResponse	Contient des données de réponse pour l’opération get.
IotHubResourceGetStatsResponse	Contient des données de réponse pour l’opération getStats.
IotHubResourceGetValidSkusNextResponse	Contient des données de réponse pour l’opération getValidSkusNext.
IotHubResourceGetValidSkusResponse	Contient des données de réponse pour l’opération getValidSkus.
IotHubResourceImportDevicesResponse	Contient des données de réponse pour l’opération importDevices.
IotHubResourceListByResourceGroupNextResponse	Contient des données de réponse pour l’opération listByResourceGroupNext.
IotHubResourceListByResourceGroupResponse	Contient des données de réponse pour l’opération listByResourceGroup.
IotHubResourceListBySubscriptionNextResponse	Contient des données de réponse pour l’opération listBySubscriptionNext.
IotHubResourceListBySubscriptionResponse	Contient des données de réponse pour l’opération listBySubscription.
IotHubResourceListEventHubConsumerGroupsNextResponse	Contient des données de réponse pour l’opération listEventHubConsumerGroupsNext.
IotHubResourceListEventHubConsumerGroupsResponse	Contient des données de réponse pour l’opération listEventHubConsumerGroups.
IotHubResourceListJobsNextResponse	Contient des données de réponse pour l’opération listJobsNext.
IotHubResourceListJobsResponse	Contient des données de réponse pour l’opération listJobs.
IotHubResourceListKeysNextResponse	Contient des données de réponse pour l’opération listKeysNext.
IotHubResourceListKeysResponse	Contient des données de réponse pour l’opération listKeys.
IotHubResourceTestAllRoutesResponse	Contient des données de réponse pour l’opération testAllRoutes.
IotHubResourceTestRouteResponse	Contient des données de réponse pour l’opération testRoute.
IotHubResourceUpdateResponse	Contient des données de réponse pour l’opération de mise à jour.
IotHubScaleType	Définit des valeurs pour IotHubScaleType.
IotHubSku	Définit des valeurs pour IotHubSku. KnownIotHubSku peut être utilisé indifféremment avec IotHubSku. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service F1 S1 S2 S3 B1 B2 B3
IotHubSkuTier	Définit des valeurs pour IotHubSkuTier.
IpFilterActionType	Définit des valeurs pour IpFilterActionType.
JobStatus	Définit des valeurs pour JobStatus.
JobType	Définit des valeurs pour JobType. KnownJobType peut être utilisé indifféremment avec JobType. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service unknown export import backup readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate
NetworkRuleIPAction	Définit des valeurs pour NetworkRuleIPAction. KnownNetworkRuleIPAction peut être utilisé de manière interchangeable avec NetworkRuleIPAction. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Autoriser
OperationsListNextResponse	Contient des données de réponse pour l’opération listNext.
OperationsListResponse	Contient des données de réponse pour l’opération de liste.
PrivateEndpointConnectionsDeleteResponse	Contient des données de réponse pour l’opération de suppression.
PrivateEndpointConnectionsGetResponse	Contient des données de réponse pour l’opération get.
PrivateEndpointConnectionsListResponse	Contient des données de réponse pour l’opération de liste.
PrivateEndpointConnectionsUpdateResponse	Contient des données de réponse pour l’opération de mise à jour.
PrivateLinkResourcesGetResponse	Contient des données de réponse pour l’opération get.
PrivateLinkResourcesListResponse	Contient des données de réponse pour l’opération de liste.
PrivateLinkServiceConnectionStatus	Définit des valeurs pour PrivateLinkServiceConnectionStatus. KnownPrivateLinkServiceConnectionStatus peut être utilisé indifféremment avec PrivateLinkServiceConnectionStatus. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service En attente Approved Rejeté Déconnecté
PublicNetworkAccess	Définit des valeurs pour PublicNetworkAccess. KnownPublicNetworkAccess peut être utilisé de manière interchangeable avec PublicNetworkAccess. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Activé Désactivé
ResourceIdentityType	Définit des valeurs pour ResourceIdentityType.
ResourceProviderCommonGetSubscriptionQuotaResponse	Contient des données de réponse pour l’opération getSubscriptionQuota.
RouteErrorSeverity	Définit des valeurs pour RouteErrorSeverity. KnownRouteErrorSeverity peut être utilisé de manière interchangeable avec RouteErrorSeverity. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service error warning
RoutingSource	Définit des valeurs pour RoutingSource. KnownRoutingSource peut être utilisé indifféremment avec RoutingSource. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Non valide DeviceMessages TwinChangeEvents DeviceLifecycleEvents DeviceJobLifecycleEvents DeviceConnectionStateEvents
RoutingStorageContainerPropertiesEncoding	Définit des valeurs pour RoutingStorageContainerPropertiesEncoding. KnownRoutingStorageContainerPropertiesEncoding peut être utilisé de manière interchangeable avec RoutingStorageContainerPropertiesEncoding. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Avro AvroDeflate JSON
TestResultStatus	Définit des valeurs pour TestResultStatus. KnownTestResultStatus peut être utilisé indifféremment avec TestResultStatus. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service non défini false true

Énumérations

KnownAuthenticationType	Valeurs connues d’AuthenticationType que le service accepte.
KnownCapabilities	Valeurs connues des fonctionnalités que le service accepte.
KnownCreatedByType	Valeurs connues de CreatedByType que le service accepte.
KnownDefaultAction	Valeurs connues de DefaultAction que le service accepte.
KnownEndpointHealthStatus	Valeurs connues de EndpointHealthStatus que le service accepte.
KnownIotHubReplicaRoleType	Valeurs connues de IotHubReplicaRoleType que le service accepte.
KnownIotHubSku	Valeurs connues de IotHubSku que le service accepte.
KnownJobType	Valeurs connues de JobType que le service accepte.
KnownNetworkRuleIPAction	Valeurs connues de NetworkRuleIPAction que le service accepte.
KnownPrivateLinkServiceConnectionStatus	Valeurs connues de PrivateLinkServiceConnectionStatus que le service accepte.
KnownPublicNetworkAccess	Valeurs connues de PublicNetworkAccess que le service accepte.
KnownRouteErrorSeverity	Valeurs connues de RouteErrorSeverity que le service accepte.
KnownRoutingSource	Valeurs connues de RoutingSource que le service accepte.
KnownRoutingStorageContainerPropertiesEncoding	Valeurs connues de RoutingStorageContainerPropertiesEncoding que le service accepte.
KnownTestResultStatus	Valeurs connues de TestResultStatus que le service accepte.

Fonctions

getContinuationToken(unknown)

Étant donné le dernier .value produit par l’itérateur byPage , retourne un jeton de continuation qui peut être utilisé pour commencer la pagination à partir de ce point ultérieurement.

Informations relatives à la fonction

getContinuationToken(unknown)

Étant donné le dernier .value produit par l’itérateur byPage , retourne un jeton de continuation qui peut être utilisé pour commencer la pagination à partir de ce point ultérieurement.

function getContinuationToken(page: unknown): string | undefined

Paramètres

page

unknown

Objet d’accès sur value IteratorResult à partir d’un byPage itérateur.

Retours

string | undefined

Jeton de continuation qui peut être transmis à byPage() lors des appels futurs.