@azure/arm-iothub package

Classi

IotHubClient

Interfacce

ArmIdentity
ArmUserIdentity
CertificateBodyDescription	Certificato X509 serializzato JSON.
CertificateDescription	Certificato X509.
CertificateListDescription	Matrice serializzata JSON di oggetti Certificate.
CertificateProperties	Descrizione di un certificato DELLA CA X509.
CertificatePropertiesWithNonce	Descrizione di un certificato della CA X509, incluso il nonce di verifica rilasciato per il flusso proof-of-possession.
CertificateVerificationDescription	Certificato foglia serializzato JSON
CertificateWithNonceDescription	Certificato X509.
Certificates	Interfaccia che rappresenta un certificato.
CertificatesCreateOrUpdateOptionalParams	Parametri facoltativi.
CertificatesDeleteOptionalParams	Parametri facoltativi.
CertificatesGenerateVerificationCodeOptionalParams	Parametri facoltativi.
CertificatesGetOptionalParams	Parametri facoltativi.
CertificatesListByIotHubOptionalParams	Parametri facoltativi.
CertificatesVerifyOptionalParams	Parametri facoltativi.
CloudToDeviceProperties	Proprietà di messaggistica da cloud a dispositivo dell'hub IoT.
EndpointHealthData	Dati di integrità per un endpoint
EndpointHealthDataListResult	Matrice serializzata JSON di oggetti EndpointHealthData con un collegamento successivo.
EnrichmentProperties	Le proprietà di un arricchimento applicato all'hub IoT ai messaggi recapitati agli endpoint.
ErrorDetails	Dettagli errore.
EventHubConsumerGroupBodyDescription	Gruppo di consumer EventHub.
EventHubConsumerGroupInfo	Proprietà dell'oggetto EventHubConsumerGroupInfo.
EventHubConsumerGroupName	Nome del gruppo di consumer EventHub.
EventHubConsumerGroupsListResult	Matrice serializzata JSON dei nomi dei gruppi di consumer compatibili con Hub eventi con un collegamento successivo.
EventHubProperties	Proprietà dell'endpoint compatibile con l'hub eventi di cui è stato effettuato il provisioning usate dall'hub IoT.
ExportDevicesRequest	Usare per specificare i parametri quando si richiede un'esportazione di tutti i dispositivi nell'hub IoT.
FailoverInput	Usare per specificare l'area di failover quando si richiede il failover manuale per un hub.
FallbackRouteProperties	Proprietà della route di fallback. hub IoT usa queste proprietà quando instrada i messaggi all'endpoint di fallback.
FeedbackProperties	Proprietà della coda di feedback per i messaggi da cloud a dispositivo.
GroupIdInformation	Informazioni sul gruppo per la creazione di un endpoint privato in un IotHub
GroupIdInformationProperties	Proprietà per un oggetto informazioni di gruppo
ImportDevicesRequest	Usare per specificare i parametri quando si richiede un'importazione di tutti i dispositivi nell'hub.
IotHub	Interfaccia che rappresenta un IotHub.
IotHubCapacity	hub IoT informazioni sulla capacità.
IotHubClientOptionalParams	Parametri facoltativi.
IotHubDescription	Descrizione dell'hub IoT.
IotHubDescriptionListResult	Matrice serializzata JSON di oggetti IotHubDescription con un collegamento successivo.
IotHubLocationDescription	Rappresentazione pubblica di una delle posizioni in cui viene effettuato il provisioning di una risorsa.
IotHubManualFailoverHeaders	Definisce le intestazioni per IotHub_manualFailover'operazione.
IotHubManualFailoverOptionalParams	Parametri facoltativi.
IotHubNameAvailabilityInfo	Proprietà che indicano se è disponibile un determinato nome dell'hub IoT.
IotHubProperties	Proprietà di un hub IoT.
IotHubQuotaMetricInfo	Proprietà delle metriche delle quote.
IotHubQuotaMetricInfoListResult	Matrice serializzata JSON di oggetti IotHubQuotaMetricInfo con un collegamento successivo.
IotHubResource	Interfaccia che rappresenta un oggetto IotHubResource.
IotHubResourceCheckNameAvailabilityOptionalParams	Parametri facoltativi.
IotHubResourceCreateEventHubConsumerGroupOptionalParams	Parametri facoltativi.
IotHubResourceCreateOrUpdateOptionalParams	Parametri facoltativi.
IotHubResourceDeleteEventHubConsumerGroupOptionalParams	Parametri facoltativi.
IotHubResourceDeleteHeaders	Definisce le intestazioni per IotHubResource_delete'operazione.
IotHubResourceDeleteOptionalParams	Parametri facoltativi.
IotHubResourceExportDevicesOptionalParams	Parametri facoltativi.
IotHubResourceGetEndpointHealthNextOptionalParams	Parametri facoltativi.
IotHubResourceGetEndpointHealthOptionalParams	Parametri facoltativi.
IotHubResourceGetEventHubConsumerGroupOptionalParams	Parametri facoltativi.
IotHubResourceGetJobOptionalParams	Parametri facoltativi.
IotHubResourceGetKeysForKeyNameOptionalParams	Parametri facoltativi.
IotHubResourceGetOptionalParams	Parametri facoltativi.
IotHubResourceGetQuotaMetricsNextOptionalParams	Parametri facoltativi.
IotHubResourceGetQuotaMetricsOptionalParams	Parametri facoltativi.
IotHubResourceGetStatsOptionalParams	Parametri facoltativi.
IotHubResourceGetValidSkusNextOptionalParams	Parametri facoltativi.
IotHubResourceGetValidSkusOptionalParams	Parametri facoltativi.
IotHubResourceImportDevicesOptionalParams	Parametri facoltativi.
IotHubResourceListByResourceGroupNextOptionalParams	Parametri facoltativi.
IotHubResourceListByResourceGroupOptionalParams	Parametri facoltativi.
IotHubResourceListBySubscriptionNextOptionalParams	Parametri facoltativi.
IotHubResourceListBySubscriptionOptionalParams	Parametri facoltativi.
IotHubResourceListEventHubConsumerGroupsNextOptionalParams	Parametri facoltativi.
IotHubResourceListEventHubConsumerGroupsOptionalParams	Parametri facoltativi.
IotHubResourceListJobsNextOptionalParams	Parametri facoltativi.
IotHubResourceListJobsOptionalParams	Parametri facoltativi.
IotHubResourceListKeysNextOptionalParams	Parametri facoltativi.
IotHubResourceListKeysOptionalParams	Parametri facoltativi.
IotHubResourceTestAllRoutesOptionalParams	Parametri facoltativi.
IotHubResourceTestRouteOptionalParams	Parametri facoltativi.
IotHubResourceUpdateOptionalParams	Parametri facoltativi.
IotHubSkuDescription	Proprietà SKU.
IotHubSkuDescriptionListResult	Matrice serializzata JSON di oggetti IotHubSkuDescription con un collegamento successivo.
IotHubSkuInfo	Informazioni sullo SKU dell'hub IoT.
IpFilterRule	Regole di filtro IP per l'hub IoT.
JobResponse	Proprietà dell'oggetto Job Response.
JobResponseListResult	Matrice serializzata JSON di oggetti JobResponse con un collegamento successivo.
ManagedIdentity	Proprietà dell'identità gestita.
MatchedRoute	Route corrispondenti
MessagingEndpointProperties	Proprietà degli endpoint di messaggistica usati da questo hub IoT.
Name	Nome del tipo di hub Iot
NetworkRuleSetIpRule	Regola IP da applicare come parte del set di regole di rete
NetworkRuleSetProperties	Proprietà del set di regole di rete di IotHub
Operation	hub IoT'operazione DELL'API REST
OperationDisplay	Oggetto che rappresenta l'operazione.
OperationInputs	Valori di input.
OperationListResult	Risultato della richiesta di elencare hub IoT operazioni. Contiene un elenco di operazioni e un collegamento URL per ottenere il set di risultati successivo.
Operations	Interfaccia che rappresenta un oggetto Operations.
OperationsListNextOptionalParams	Parametri facoltativi.
OperationsListOptionalParams	Parametri facoltativi.
PrivateEndpoint	Proprietà dell'endpoint privato di una connessione all'endpoint privato
PrivateEndpointConnection	Connessione dell'endpoint privato di un IotHub
PrivateEndpointConnectionProperties	Proprietà di una connessione endpoint privato
PrivateEndpointConnections	Interfaccia che rappresenta un oggetto PrivateEndpointConnections.
PrivateEndpointConnectionsDeleteHeaders	Definisce le intestazioni per PrivateEndpointConnections_delete'operazione.
PrivateEndpointConnectionsDeleteOptionalParams	Parametri facoltativi.
PrivateEndpointConnectionsGetOptionalParams	Parametri facoltativi.
PrivateEndpointConnectionsListOptionalParams	Parametri facoltativi.
PrivateEndpointConnectionsUpdateOptionalParams	Parametri facoltativi.
PrivateLinkResources	Risorse di collegamento privato disponibili per un IotHub
PrivateLinkResourcesGetOptionalParams	Parametri facoltativi.
PrivateLinkResourcesListOptionalParams	Parametri facoltativi.
PrivateLinkResourcesOperations	Interfaccia che rappresenta un oggetto PrivateLinkResourcesOperations.
PrivateLinkServiceConnectionState	Stato corrente di una connessione endpoint privato
RegistryStatistics	Statistiche del Registro di sistema delle identità.
Resource	Proprietà comuni di una risorsa di Azure.
ResourceProviderCommon	Interfaccia che rappresenta un oggetto ResourceProviderCommon.
ResourceProviderCommonGetSubscriptionQuotaOptionalParams	Parametri facoltativi.
RouteCompilationError	Errore di compilazione durante la valutazione della route
RouteErrorPosition	Posizione in cui si è verificato l'errore di route
RouteErrorRange	Intervallo di errori di route
RouteProperties	Le proprietà di una regola di routing usata dall'hub IoT per instradare i messaggi agli endpoint.
RoutingCosmosDBSqlApiProperties	Proprietà correlate a un endpoint del contenitore SQL di Cosmos DB.
RoutingEndpoints	Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT instrada i messaggi in base alle regole di routing. È consentito un massimo di 10 endpoint personalizzati in tutti i tipi di endpoint per gli hub a pagamento e solo 1 endpoint personalizzato è consentito in tutti i tipi di endpoint per gli hub gratuiti.
RoutingEventHubProperties	Proprietà correlate a un endpoint dell'hub eventi.
RoutingMessage	Messaggio di routing
RoutingProperties	Proprietà correlate al routing dell'hub IoT. Vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Proprietà correlate ai tipi di endpoint della coda del bus di servizio.
RoutingServiceBusTopicEndpointProperties	Proprietà correlate ai tipi di endpoint dell'argomento del bus di servizio.
RoutingStorageContainerProperties	Proprietà correlate a un endpoint del contenitore di archiviazione.
RoutingTwin	Parametro di input del riferimento gemello. Si tratta di un parametro facoltativo
RoutingTwinProperties
SharedAccessSignatureAuthorizationRule	Proprietà di un criterio di accesso condiviso dell'hub IoT.
SharedAccessSignatureAuthorizationRuleListResult	Elenco dei criteri di accesso condiviso con un collegamento successivo.
StorageEndpointProperties	Proprietà dell'endpoint di Archiviazione di Azure per il caricamento di file.
SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
TagsResource	Un contenitore che contiene solo i tag per una risorsa, consentendo all'utente di aggiornare i tag in un'istanza di hub IoT.
TestAllRoutesInput	Input per il test di tutte le route
TestAllRoutesResult	Risultato del test di tutte le route
TestRouteInput	Input per la route di test
TestRouteResult	Risultato del test di una route
TestRouteResultDetails	Risultato dettagliato del test di una route
UserSubscriptionQuota	Risposta della quota di sottoscrizione utente
UserSubscriptionQuotaListResult	Matrice serializzata json della risposta della quota di sottoscrizione utente

Alias tipo

AccessRights	Definisce i valori per AccessRights.
AuthenticationType	Definisce i valori per AuthenticationType. KnownAuthenticationType può essere usato in modo intercambiabile con AuthenticationType. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio keyBased identityBased
Capabilities	Definisce i valori per Capabilities. KnownCapabilities può essere usato in modo intercambiabile con Capabilities, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Nessuna DeviceManagement
CertificatesCreateOrUpdateResponse	Contiene i dati di risposta per l'operazione createOrUpdate.
CertificatesGenerateVerificationCodeResponse	Contiene i dati di risposta per l'operazione generateVerificationCode.
CertificatesGetResponse	Contiene i dati di risposta per l'operazione get.
CertificatesListByIotHubResponse	Contiene i dati di risposta per l'operazione listByIotHub.
CertificatesVerifyResponse	Contiene i dati di risposta per l'operazione di verifica.
CreatedByType	Definisce i valori per CreatedByType. KnownCreatedByType può essere usato in modo intercambiabile con CreatedByType. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Utente Applicazione ManagedIdentity Chiave
DefaultAction	Definisce i valori per DefaultAction. KnownDefaultAction può essere usato in modo intercambiabile con DefaultAction. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Nega Consentito
EndpointHealthStatus	Definisce i valori per EndpointHealthStatus. KnownEndpointHealthStatus può essere usato in modo intercambiabile con EndpointHealthStatus. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Sconosciuto Sano Degradata Malsano Morto
IotHubNameUnavailabilityReason	Definisce i valori per IotHubNameUnavailabilityReason.
IotHubReplicaRoleType	Definisce i valori per IotHubReplicaRoleType. KnownIotHubReplicaRoleType può essere usato in modo intercambiabile con IotHubReplicaRoleType. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Primario Secondario
IotHubResourceCheckNameAvailabilityResponse	Contiene i dati di risposta per l'operazione checkNameAvailability.
IotHubResourceCreateEventHubConsumerGroupResponse	Contiene i dati di risposta per l'operazione createEventHubConsumerGroup.
IotHubResourceCreateOrUpdateResponse	Contiene i dati di risposta per l'operazione createOrUpdate.
IotHubResourceDeleteResponse	Contiene i dati di risposta per l'operazione di eliminazione.
IotHubResourceExportDevicesResponse	Contiene i dati di risposta per l'operazione exportDevices.
IotHubResourceGetEndpointHealthNextResponse	Contiene i dati di risposta per l'operazione getEndpointHealthNext.
IotHubResourceGetEndpointHealthResponse	Contiene i dati di risposta per l'operazione getEndpointHealth.
IotHubResourceGetEventHubConsumerGroupResponse	Contiene i dati di risposta per l'operazione getEventHubConsumerGroup.
IotHubResourceGetJobResponse	Contiene i dati di risposta per l'operazione getJob.
IotHubResourceGetKeysForKeyNameResponse	Contiene i dati di risposta per l'operazione getKeysForKeyName.
IotHubResourceGetQuotaMetricsNextResponse	Contiene i dati di risposta per l'operazione getQuotaMetricsNext.
IotHubResourceGetQuotaMetricsResponse	Contiene i dati di risposta per l'operazione getQuotaMetrics.
IotHubResourceGetResponse	Contiene i dati di risposta per l'operazione get.
IotHubResourceGetStatsResponse	Contiene i dati di risposta per l'operazione getStats.
IotHubResourceGetValidSkusNextResponse	Contiene i dati di risposta per l'operazione getValidSkusNext.
IotHubResourceGetValidSkusResponse	Contiene i dati di risposta per l'operazione getValidSkus.
IotHubResourceImportDevicesResponse	Contiene i dati di risposta per l'operazione importDevices.
IotHubResourceListByResourceGroupNextResponse	Contiene i dati di risposta per l'operazione listByResourceGroupNext.
IotHubResourceListByResourceGroupResponse	Contiene i dati di risposta per l'operazione listByResourceGroup.
IotHubResourceListBySubscriptionNextResponse	Contiene i dati di risposta per l'operazione listBySubscriptionNext.
IotHubResourceListBySubscriptionResponse	Contiene i dati di risposta per l'operazione listBySubscription.
IotHubResourceListEventHubConsumerGroupsNextResponse	Contiene i dati di risposta per l'operazione listEventHubConsumerGroupsNext.
IotHubResourceListEventHubConsumerGroupsResponse	Contiene i dati di risposta per l'operazione listEventHubConsumerGroups.
IotHubResourceListJobsNextResponse	Contiene i dati di risposta per l'operazione listJobsNext.
IotHubResourceListJobsResponse	Contiene i dati di risposta per l'operazione listJobs.
IotHubResourceListKeysNextResponse	Contiene i dati di risposta per l'operazione listKeysNext.
IotHubResourceListKeysResponse	Contiene i dati di risposta per l'operazione listKeys.
IotHubResourceTestAllRoutesResponse	Contiene i dati di risposta per l'operazione testAllRoutes.
IotHubResourceTestRouteResponse	Contiene i dati di risposta per l'operazione testRoute.
IotHubResourceUpdateResponse	Contiene i dati di risposta per l'operazione di aggiornamento.
IotHubScaleType	Definisce i valori per IotHubScaleType.
IotHubSku	Definisce i valori per IotHubSku. KnownIotHubSku può essere usato in modo intercambiabile con IotHubSku, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio F1 S1 S2 S3 B1 B2 B3
IotHubSkuTier	Definisce i valori per IotHubSkuTier.
IpFilterActionType	Definisce i valori per IpFilterActionType.
JobStatus	Definisce i valori per JobStatus.
JobType	Definisce i valori per JobType. KnownJobType può essere usato in modo intercambiabile con JobType. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Sconosciuto Esportazione import Backup readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate
NetworkRuleIPAction	Definisce i valori per NetworkRuleIPAction. KnownNetworkRuleIPAction può essere usato in modo intercambiabile con NetworkRuleIPAction. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Consentito
OperationsListNextResponse	Contiene i dati di risposta per l'operazione listNext.
OperationsListResponse	Contiene i dati di risposta per l'operazione di elenco.
PrivateEndpointConnectionsDeleteResponse	Contiene i dati di risposta per l'operazione di eliminazione.
PrivateEndpointConnectionsGetResponse	Contiene i dati di risposta per l'operazione get.
PrivateEndpointConnectionsListResponse	Contiene i dati di risposta per l'operazione di elenco.
PrivateEndpointConnectionsUpdateResponse	Contiene i dati di risposta per l'operazione di aggiornamento.
PrivateLinkResourcesGetResponse	Contiene i dati di risposta per l'operazione get.
PrivateLinkResourcesListResponse	Contiene i dati di risposta per l'operazione di elenco.
PrivateLinkServiceConnectionStatus	Definisce i valori per PrivateLinkServiceConnectionStatus. KnownPrivateLinkServiceConnectionStatus può essere usato in modo intercambiabile con PrivateLinkServiceConnectionStatus. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio In sospeso Approved Rifiutato Disconnesso
PublicNetworkAccess	Definisce i valori per PublicNetworkAccess. KnownPublicNetworkAccess può essere usato in modo intercambiabile con PublicNetworkAccess. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Enabled Disabilitato
ResourceIdentityType	Definisce i valori per ResourceIdentityType.
ResourceProviderCommonGetSubscriptionQuotaResponse	Contiene i dati di risposta per l'operazione getSubscriptionQuota.
RouteErrorSeverity	Definisce i valori per RouteErrorSeverity. KnownRouteErrorSeverity può essere usato in modo intercambiabile con RouteErrorSeverity. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio error warning
RoutingSource	Definisce i valori per RoutingSource. KnownRoutingSource può essere usato in modo intercambiabile con RoutingSource. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Non valido DeviceMessages TwinChangeEvents DeviceLifecycleEvents DeviceJobLifecycleEvents DeviceConnectionStateEvents
RoutingStorageContainerPropertiesEncoding	Definisce i valori per RoutingStorageContainerPropertiesEncoding. KnownRoutingStorageContainerPropertiesEncoding può essere usato in modo intercambiabile con RoutingStorageContainerPropertiesEncoding, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Avro AvroDeflate JSON
TestResultStatus	Definisce i valori per TestResultStatus. NotoTestResultStatus può essere usato in modo intercambiabile con TestResultStatus, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Non definito false true

Enumerazioni

KnownAuthenticationType	Valori noti di AuthenticationType accettati dal servizio.
KnownCapabilities	Valori noti di Capabilities accettati dal servizio.
KnownCreatedByType	Valori noti di CreatedByType accettati dal servizio.
KnownDefaultAction	Valori noti di DefaultAction accettati dal servizio.
KnownEndpointHealthStatus	Valori noti di EndpointHealthStatus accettati dal servizio.
KnownIotHubReplicaRoleType	Valori noti di IotHubReplicaRoleType accettati dal servizio.
KnownIotHubSku	Valori noti di IotHubSku accettati dal servizio.
KnownJobType	Valori noti di JobType accettati dal servizio.
KnownNetworkRuleIPAction	Valori noti di NetworkRuleIPAction accettati dal servizio.
KnownPrivateLinkServiceConnectionStatus	Valori noti di PrivateLinkServiceConnectionStatus accettati dal servizio.
KnownPublicNetworkAccess	Valori noti di PublicNetworkAccess accettati dal servizio.
KnownRouteErrorSeverity	Valori noti di RouteErrorSeverity accettati dal servizio.
KnownRoutingSource	Valori noti di RoutingSource accettati dal servizio.
KnownRoutingStorageContainerPropertiesEncoding	Valori noti di RoutingStorageContainerPropertiesEncoding accettati dal servizio.
KnownTestResultStatus	Valori noti di TestResultStatus accettati dal servizio.

Funzioni

getContinuationToken(unknown)

Dato l'ultimo .value prodotto dall'iteratore byPage , restituisce un token di continuazione che può essere usato per iniziare il paging da quel punto in un secondo momento.

Dettagli funzione

getContinuationToken(unknown)

Dato l'ultimo .value prodotto dall'iteratore byPage , restituisce un token di continuazione che può essere usato per iniziare il paging da quel punto in un secondo momento.

function getContinuationToken(page: unknown): string | undefined

Parametri

page

unknown

Oggetto dall'accesso value all'iteratorResult da un byPage iteratore.

Restituisce

string | undefined

Token di continuazione che può essere passato a byPage() durante le chiamate future.