Condividi tramite


@azure/arm-iothub-profile-2020-09-01-hybrid package

Classi

IotHubClient

Interfacce

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.

EventHubConsumerGroupInfo

Proprietà dell'oggetto EventHubConsumerGroupInfo.

EventHubConsumerGroupsListResult

Matrice serializzata JSON dei nomi dei gruppi di consumer compatibili con Hub eventi con un collegamento successivo.

EventHubProperties

Proprietà dell'endpoint compatibile con 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 fornire l'area di failover quando si richiede failover manuale per un hub.

FallbackRouteProperties

Proprietà della route di fallback. L'hub IoT usa queste proprietà quando indirizza i messaggi all'endpoint di fallback.

FeedbackProperties

Proprietà della coda di feedback per i messaggi da cloud a dispositivo.

ImportDevicesRequest

Usare per fornire parametri quando si richiede un'importazione di tutti i dispositivi nell'hub.

IotHub

Interfaccia che rappresenta un IotHub.

IotHubCapacity

Informazioni sulla capacità dell'hub IoT.

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.

IotHubManualFailoverOptionalParams

Parametri facoltativi.

IotHubNameAvailabilityInfo

Proprietà che indicano se è disponibile un determinato nome dell'hub IoT.

IotHubProperties

Proprietà di un hub IoT.

IotHubPropertiesDeviceStreams

Le proprietà dei flussi del dispositivo di iothub.

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.

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.

MatchedRoute

Route corrispondenti

MessagingEndpointProperties

Proprietà degli endpoint di messaggistica usati da questo hub IoT.

Name

Nome del tipo di hub Iot

Operation

Operazione dell'API REST dell'hub IoT

OperationDisplay

Oggetto che rappresenta l'operazione.

OperationInputs

Valori di input.

OperationListResult

Risultato della richiesta per elencare le operazioni dell'hub IoT. 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.

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

Proprietà di una regola di routing usata dall'hub IoT per instradare i messaggi agli endpoint.

RoutingEndpoints

Le proprietà correlate agli endpoint personalizzati a cui l'hub IoT instrada i messaggi in base alle regole di routing. Un massimo di 10 endpoint personalizzati è consentito 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 di 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.

TagsResource

Un contenitore che contiene solo i tag per una risorsa, consentendo all'utente di aggiornare i tag in un'istanza dell'hub IoT.

TestAllRoutesInput

Input per il test di tutte le route

TestAllRoutesResult

Risultato del test di tutte le route

TestRouteInput

Input per il test della route

TestRouteResult

Risultato del test di una route

TestRouteResultDetails

Risultato dettagliato del test di una route

UserSubscriptionQuota

Risposta alla quota di sottoscrizione utente

UserSubscriptionQuotaListResult

Matrice serializzata json della risposta della quota di sottoscrizione utente

Alias tipo

AccessRights

Definisce i valori per AccessRights.

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.

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
integro
non integro
inattivo

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
di esportazione
importare
di backup
readDeviceProperties
writeDeviceProperties
updateDeviceConfiguration
rebootDevice
factoryResetDevice
firmware Aggiornare

OperationsListNextResponse

Contiene i dati di risposta per l'operazione listNext.

OperationsListResponse

Contiene i dati di risposta per l'operazione di elenco.

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

errore
avviso

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
DigitalTwinChangeEvents

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.
KnownTestResultStatus può essere usato in modo intercambiabile con TestResultStatus, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

non definito
false
true

Enumerazioni

KnownCapabilities

Valori noti di Capabilities 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.

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 a value sull'IteratorResult da un iteratore byPage.

Restituisce

string | undefined

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