@azure/arm-iothub package

Klassen

IotHubClient

Interfaces

ArmIdentity
ArmUserIdentity
CertificateBodyDescription	Het JSON-geserialiseerde X509-certificaat.
CertificateDescription	Het X509-certificaat.
CertificateListDescription	De JSON-geserialiseerde matrix van certificaatobjecten.
CertificateProperties	De beschrijving van een X509-CA-certificaat.
CertificatePropertiesWithNonce	De beschrijving van een X509-CA-certificaat, inclusief de nonce voor de vraag die is uitgegeven voor de stroom bewijs van bezit.
CertificateVerificationDescription	Het JSON-geserialiseerde leaf-certificaat
CertificateWithNonceDescription	Het X509-certificaat.
Certificates	Interface die een certificaat vertegenwoordigt.
CertificatesCreateOrUpdateOptionalParams	Optionele parameters.
CertificatesDeleteOptionalParams	Optionele parameters.
CertificatesGenerateVerificationCodeOptionalParams	Optionele parameters.
CertificatesGetOptionalParams	Optionele parameters.
CertificatesListByIotHubOptionalParams	Optionele parameters.
CertificatesVerifyOptionalParams	Optionele parameters.
CloudToDeviceProperties	De cloud-naar-apparaat-berichteneigenschappen van de IoT-hub.
EndpointHealthData	De statusgegevens voor een eindpunt
EndpointHealthDataListResult	De JSON-geserialiseerde matrix van EndpointHealthData-objecten met een volgende koppeling.
EnrichmentProperties	De eigenschappen van een verrijking die uw IoT-hub toepast op berichten die aan eindpunten worden geleverd.
ErrorDetails	Foutdetails.
EventHubConsumerGroupBodyDescription	De EventHub-consumentengroep.
EventHubConsumerGroupInfo	De eigenschappen van het object EventHubConsumerGroupInfo.
EventHubConsumerGroupName	De naam van de EventHub-consumentengroep.
EventHubConsumerGroupsListResult	De JSON-geserialiseerde matrix met event hub-compatibele namen van consumentengroepen met een volgende koppeling.
EventHubProperties	De eigenschappen van het ingerichte Event Hub-compatibele eindpunt dat wordt gebruikt door de IoT-hub.
ExportDevicesRequest	Gebruik om parameters op te geven bij het aanvragen van een export van alle apparaten in de IoT-hub.
FailoverInput	Gebruik om een failoverregio op te geven bij het aanvragen van handmatige failover voor een hub.
FallbackRouteProperties	De eigenschappen van de terugvalroute. IoT Hub gebruikt deze eigenschappen wanneer berichten worden gerouteerd naar het terugvaleindpunt.
FeedbackProperties	De eigenschappen van de feedbackwachtrij voor cloud-naar-apparaat-berichten.
GroupIdInformation	De groepsinformatie voor het maken van een privé-eindpunt op een IotHub
GroupIdInformationProperties	De eigenschappen voor een groepsinformatieobject
ImportDevicesRequest	Gebruik om parameters op te geven bij het aanvragen van een import van alle apparaten in de hub.
IotHub	Interface die een IotHub vertegenwoordigt.
IotHubCapacity	IoT Hub capaciteitsgegevens.
IotHubClientOptionalParams	Optionele parameters.
IotHubDescription	De beschrijving van de IoT-hub.
IotHubDescriptionListResult	De JSON-geserialiseerde matrix van IotHubDescription-objecten met een volgende koppeling.
IotHubLocationDescription	Openbare weergave van een van de locaties waar een resource is ingericht.
IotHubManualFailoverHeaders	Hiermee definieert u headers voor IotHub_manualFailover bewerking.
IotHubManualFailoverOptionalParams	Optionele parameters.
IotHubNameAvailabilityInfo	De eigenschappen die aangeven of een bepaalde Naam van een IoT-hub beschikbaar is.
IotHubProperties	De eigenschappen van een IoT-hub.
IotHubQuotaMetricInfo	Eigenschappen van metrische gegevens van quotum.
IotHubQuotaMetricInfoListResult	De JSON-geserialiseerde matrix van IotHubQuotaMetricInfo-objecten met een volgende koppeling.
IotHubResource	Interface die een IotHubResource vertegenwoordigt.
IotHubResourceCheckNameAvailabilityOptionalParams	Optionele parameters.
IotHubResourceCreateEventHubConsumerGroupOptionalParams	Optionele parameters.
IotHubResourceCreateOrUpdateOptionalParams	Optionele parameters.
IotHubResourceDeleteEventHubConsumerGroupOptionalParams	Optionele parameters.
IotHubResourceDeleteHeaders	Hiermee definieert u headers voor IotHubResource_delete bewerking.
IotHubResourceDeleteOptionalParams	Optionele parameters.
IotHubResourceExportDevicesOptionalParams	Optionele parameters.
IotHubResourceGetEndpointHealthNextOptionalParams	Optionele parameters.
IotHubResourceGetEndpointHealthOptionalParams	Optionele parameters.
IotHubResourceGetEventHubConsumerGroupOptionalParams	Optionele parameters.
IotHubResourceGetJobOptionalParams	Optionele parameters.
IotHubResourceGetKeysForKeyNameOptionalParams	Optionele parameters.
IotHubResourceGetOptionalParams	Optionele parameters.
IotHubResourceGetQuotaMetricsNextOptionalParams	Optionele parameters.
IotHubResourceGetQuotaMetricsOptionalParams	Optionele parameters.
IotHubResourceGetStatsOptionalParams	Optionele parameters.
IotHubResourceGetValidSkusNextOptionalParams	Optionele parameters.
IotHubResourceGetValidSkusOptionalParams	Optionele parameters.
IotHubResourceImportDevicesOptionalParams	Optionele parameters.
IotHubResourceListByResourceGroupNextOptionalParams	Optionele parameters.
IotHubResourceListByResourceGroupOptionalParams	Optionele parameters.
IotHubResourceListBySubscriptionNextOptionalParams	Optionele parameters.
IotHubResourceListBySubscriptionOptionalParams	Optionele parameters.
IotHubResourceListEventHubConsumerGroupsNextOptionalParams	Optionele parameters.
IotHubResourceListEventHubConsumerGroupsOptionalParams	Optionele parameters.
IotHubResourceListJobsNextOptionalParams	Optionele parameters.
IotHubResourceListJobsOptionalParams	Optionele parameters.
IotHubResourceListKeysNextOptionalParams	Optionele parameters.
IotHubResourceListKeysOptionalParams	Optionele parameters.
IotHubResourceTestAllRoutesOptionalParams	Optionele parameters.
IotHubResourceTestRouteOptionalParams	Optionele parameters.
IotHubResourceUpdateOptionalParams	Optionele parameters.
IotHubSkuDescription	SKU-eigenschappen.
IotHubSkuDescriptionListResult	De JSON-geserialiseerde matrix van IotHubSkuDescription-objecten met een volgende koppeling.
IotHubSkuInfo	Informatie over de SKU van de IoT-hub.
IpFilterRule	De IP-filterregels voor de IoT-hub.
JobResponse	De eigenschappen van het object Taakantwoord.
JobResponseListResult	De JSON-geserialiseerde matrix van JobResponse-objecten met een volgende koppeling.
ManagedIdentity	De eigenschappen van de beheerde identiteit.
MatchedRoute	Routes die overeenkomen met
MessagingEndpointProperties	De eigenschappen van de berichteneindpunten die door deze IoT-hub worden gebruikt.
Name	Naam van iot-hubtype
NetworkRuleSetIpRule	IP-regel die moet worden toegepast als onderdeel van netwerkregelset
NetworkRuleSetProperties	Eigenschappen van netwerkregelset van IotHub
Operation	IOT HUB REST API-bewerking
OperationDisplay	Het object dat de bewerking vertegenwoordigt.
OperationInputs	Invoerwaarden.
OperationListResult	Resultaat van de aanvraag om IoT Hub bewerkingen weer te geven. Het bevat een lijst met bewerkingen en een URL-koppeling om de volgende set resultaten op te halen.
Operations	Interface die een bewerking vertegenwoordigt.
OperationsListNextOptionalParams	Optionele parameters.
OperationsListOptionalParams	Optionele parameters.
PrivateEndpoint	De privé-eindpunteigenschap van een privé-eindpuntverbinding
PrivateEndpointConnection	De privé-eindpuntverbinding van een IotHub
PrivateEndpointConnectionProperties	De eigenschappen van een privé-eindpuntverbinding
PrivateEndpointConnections	Interface die een PrivateEndpointConnections vertegenwoordigt.
PrivateEndpointConnectionsDeleteHeaders	Hiermee definieert u headers voor PrivateEndpointConnections_delete bewerking.
PrivateEndpointConnectionsDeleteOptionalParams	Optionele parameters.
PrivateEndpointConnectionsGetOptionalParams	Optionele parameters.
PrivateEndpointConnectionsListOptionalParams	Optionele parameters.
PrivateEndpointConnectionsUpdateOptionalParams	Optionele parameters.
PrivateLinkResources	De beschikbare privékoppelingsresources voor een IotHub
PrivateLinkResourcesGetOptionalParams	Optionele parameters.
PrivateLinkResourcesListOptionalParams	Optionele parameters.
PrivateLinkResourcesOperations	Interface die een PrivateLinkResourcesOperations vertegenwoordigt.
PrivateLinkServiceConnectionState	De huidige status van een privé-eindpuntverbinding
RegistryStatistics	Statistieken van het identiteitsregister.
Resource	De algemene eigenschappen van een Azure-resource.
ResourceProviderCommon	Interface die een ResourceProviderCommon vertegenwoordigt.
ResourceProviderCommonGetSubscriptionQuotaOptionalParams	Optionele parameters.
RouteCompilationError	Compilatiefout bij het evalueren van de route
RouteErrorPosition	Positie waar de routefout is opgetreden
RouteErrorRange	Bereik van routefouten
RouteProperties	De eigenschappen van een regel voor doorsturen die uw IoT-hub gebruikt om berichten naar eindpunten te routeren.
RoutingCosmosDBSqlApiProperties	De eigenschappen met betrekking tot een cosmos DB SQL-containereindpunt.
RoutingEndpoints	De eigenschappen met betrekking tot de aangepaste eindpunten waarnaar uw IoT-hub berichten routeert op basis van de routeringsregels. Er zijn maximaal 10 aangepaste eindpunten toegestaan voor alle eindpunttypen voor betaalde hubs en er is slechts 1 aangepast eindpunt toegestaan voor alle eindpunttypen voor gratis hubs.
RoutingEventHubProperties	De eigenschappen met betrekking tot een Event Hub-eindpunt.
RoutingMessage	Routeringsbericht
RoutingProperties	De routeringsgerelateerde eigenschappen van de IoT-hub. Zie: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	De eigenschappen met betrekking tot eindpunttypen service bus-wachtrijen.
RoutingServiceBusTopicEndpointProperties	De eigenschappen met betrekking tot eindpunttypen van Service Bus-onderwerpen.
RoutingStorageContainerProperties	De eigenschappen met betrekking tot een eindpunt van een opslagcontainer.
RoutingTwin	Invoerparameter voor dubbelreferenties. Dit is een optionele parameter
RoutingTwinProperties
SharedAccessSignatureAuthorizationRule	De eigenschappen van een beleid voor gedeelde toegang van IoT Hub.
SharedAccessSignatureAuthorizationRuleListResult	De lijst met beleid voor gedeelde toegang met een volgende koppeling.
StorageEndpointProperties	De eigenschappen van het Azure Storage-eindpunt voor het uploaden van bestanden.
SystemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
TagsResource	Een container met alleen de tags voor een resource, zodat de gebruiker de tags op een IoT Hub-exemplaar kan bijwerken.
TestAllRoutesInput	Invoer voor het testen van alle routes
TestAllRoutesResult	Resultaat van het testen van alle routes
TestRouteInput	Invoer voor het testen van de route
TestRouteResult	Resultaat van het testen van één route
TestRouteResultDetails	Gedetailleerd resultaat van het testen van een route
UserSubscriptionQuota	Antwoord op quotum voor gebruikersabonnementen
UserSubscriptionQuotaListResult	Json-geserialiseerde matrix van quotumantwoord voor gebruikersabonnementen

Type-aliassen

AccessRights	Definieert waarden voor AccessRights.
AuthenticationType	Definieert waarden voor AuthenticationType. KnownAuthenticationType kan door elkaar worden gebruikt met AuthenticationType. Deze opsomming bevat de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund keyBased identityBased
Capabilities	Definieert waarden voor Mogelijkheden. KnownCapabilities kunnen door elkaar worden gebruikt met Capabilities. Deze opsomming bevat de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Geen DeviceManagement
CertificatesCreateOrUpdateResponse	Bevat antwoordgegevens voor de bewerking createOrUpdate.
CertificatesGenerateVerificationCodeResponse	Bevat antwoordgegevens voor de bewerking generateVerificationCode.
CertificatesGetResponse	Bevat antwoordgegevens voor de get-bewerking.
CertificatesListByIotHubResponse	Bevat antwoordgegevens voor de listByIotHub-bewerking.
CertificatesVerifyResponse	Bevat antwoordgegevens voor de controlebewerking.
CreatedByType	Definieert waarden voor CreatedByType. KnownCreatedByType kan door elkaar worden gebruikt met CreatedByType. Deze opsomming bevat de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund Gebruiker Toepassing ManagedIdentity Sleutel
DefaultAction	Definieert waarden voor DefaultAction. KnownDefaultAction kan door elkaar worden gebruikt met DefaultAction. Deze opsomming bevat de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund Weigeren Toestaan
EndpointHealthStatus	Definieert waarden voor EndpointHealthStatus. KnownEndpointHealthStatus kan door elkaar worden gebruikt met EndpointHealthStatus. Deze opsomming bevat de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund Onbekende Gezonde Gedegradeerd Ongezonde Dood
IotHubNameUnavailabilityReason	Definieert waarden voor IotHubNameUnavailabilityReason.
IotHubReplicaRoleType	Definieert waarden voor IotHubReplicaRoleType. KnownIotHubReplicaRoleType kan door elkaar worden gebruikt met IotHubReplicaRoleType. Deze opsomming bevat de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund Primaire Secundaire
IotHubResourceCheckNameAvailabilityResponse	Bevat antwoordgegevens voor de bewerking checkNameAvailability.
IotHubResourceCreateEventHubConsumerGroupResponse	Bevat antwoordgegevens voor de bewerking createEventHubConsumerGroup.
IotHubResourceCreateOrUpdateResponse	Bevat antwoordgegevens voor de bewerking createOrUpdate.
IotHubResourceDeleteResponse	Bevat antwoordgegevens voor de verwijderbewerking.
IotHubResourceExportDevicesResponse	Bevat antwoordgegevens voor de bewerking exportDevices.
IotHubResourceGetEndpointHealthNextResponse	Bevat antwoordgegevens voor de bewerking getEndpointHealthNext.
IotHubResourceGetEndpointHealthResponse	Bevat antwoordgegevens voor de bewerking getEndpointHealth.
IotHubResourceGetEventHubConsumerGroupResponse	Bevat antwoordgegevens voor de bewerking getEventHubConsumerGroup.
IotHubResourceGetJobResponse	Bevat antwoordgegevens voor de getJob-bewerking.
IotHubResourceGetKeysForKeyNameResponse	Bevat antwoordgegevens voor de bewerking getKeysForKeyName.
IotHubResourceGetQuotaMetricsNextResponse	Bevat antwoordgegevens voor de bewerking getQuotaMetricsNext.
IotHubResourceGetQuotaMetricsResponse	Bevat antwoordgegevens voor de bewerking getQuotaMetrics.
IotHubResourceGetResponse	Bevat antwoordgegevens voor de get-bewerking.
IotHubResourceGetStatsResponse	Bevat antwoordgegevens voor de getStats-bewerking.
IotHubResourceGetValidSkusNextResponse	Bevat antwoordgegevens voor de bewerking getValidSkusNext.
IotHubResourceGetValidSkusResponse	Bevat antwoordgegevens voor de bewerking getValidSkus.
IotHubResourceImportDevicesResponse	Bevat antwoordgegevens voor de bewerking importDevices.
IotHubResourceListByResourceGroupNextResponse	Bevat antwoordgegevens voor de bewerking listByResourceGroupNext.
IotHubResourceListByResourceGroupResponse	Bevat antwoordgegevens voor de bewerking listByResourceGroup.
IotHubResourceListBySubscriptionNextResponse	Bevat antwoordgegevens voor de bewerking listBySubscriptionNext.
IotHubResourceListBySubscriptionResponse	Bevat antwoordgegevens voor de bewerking listBySubscription.
IotHubResourceListEventHubConsumerGroupsNextResponse	Bevat antwoordgegevens voor de bewerking listEventHubConsumerGroupsNext.
IotHubResourceListEventHubConsumerGroupsResponse	Bevat antwoordgegevens voor de bewerking listEventHubConsumerGroups.
IotHubResourceListJobsNextResponse	Bevat antwoordgegevens voor de bewerking listJobsNext.
IotHubResourceListJobsResponse	Bevat antwoordgegevens voor de listJobs-bewerking.
IotHubResourceListKeysNextResponse	Bevat antwoordgegevens voor de bewerking listKeysNext.
IotHubResourceListKeysResponse	Bevat antwoordgegevens voor de bewerking listKeys.
IotHubResourceTestAllRoutesResponse	Bevat antwoordgegevens voor de bewerking testAllRoutes.
IotHubResourceTestRouteResponse	Bevat antwoordgegevens voor de testRoute-bewerking.
IotHubResourceUpdateResponse	Bevat antwoordgegevens voor de updatebewerking.
IotHubScaleType	Definieert waarden voor IotHubScaleType.
IotHubSku	Definieert waarden voor IotHubSku. KnownIotHubSku kan door elkaar worden gebruikt met IotHubSku. Deze opsomming bevat de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund F1 S1 S2 S3 B1 B2 B3
IotHubSkuTier	Definieert waarden voor IotHubSkuTier.
IpFilterActionType	Definieert waarden voor IpFilterActionType.
JobStatus	Definieert waarden voor JobStatus.
JobType	Definieert waarden voor JobType. KnownJobType kan door elkaar worden gebruikt met JobType. Deze opsomming bevat de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund Onbekende Exporteren import Backup readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate
NetworkRuleIPAction	Definieert waarden voor NetworkRuleIPAction. KnownNetworkRuleIPAction kan door elkaar worden gebruikt met NetworkRuleIPAction. Deze opsomming bevat de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund Toestaan
OperationsListNextResponse	Bevat antwoordgegevens voor de bewerking listNext.
OperationsListResponse	Bevat antwoordgegevens voor de lijstbewerking.
PrivateEndpointConnectionsDeleteResponse	Bevat antwoordgegevens voor de verwijderbewerking.
PrivateEndpointConnectionsGetResponse	Bevat antwoordgegevens voor de get-bewerking.
PrivateEndpointConnectionsListResponse	Bevat antwoordgegevens voor de lijstbewerking.
PrivateEndpointConnectionsUpdateResponse	Bevat antwoordgegevens voor de updatebewerking.
PrivateLinkResourcesGetResponse	Bevat antwoordgegevens voor de get-bewerking.
PrivateLinkResourcesListResponse	Bevat antwoordgegevens voor de lijstbewerking.
PrivateLinkServiceConnectionStatus	Definieert waarden voor PrivateLinkServiceConnectionStatus. KnownPrivateLinkServiceConnectionStatus kan door elkaar worden gebruikt met PrivateLinkServiceConnectionStatus. Deze opsomming bevat de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund In behandeling Goedgekeurd Afgewezen Ontkoppeld
PublicNetworkAccess	Definieert waarden voor PublicNetworkAccess. KnownPublicNetworkAccess kan door elkaar worden gebruikt met PublicNetworkAccess. Deze opsomming bevat de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Ingeschakeld Uitgeschakeld
ResourceIdentityType	Definieert waarden voor ResourceIdentityType.
ResourceProviderCommonGetSubscriptionQuotaResponse	Bevat antwoordgegevens voor de bewerking getSubscriptionQuota.
RouteErrorSeverity	Definieert waarden voor RouteErrorSeverity. KnownRouteErrorSeverity kan door elkaar worden gebruikt met RouteErrorSeverity. Deze opsomming bevat de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund Fout Waarschuwing
RoutingSource	Definieert waarden voor RoutingSource. KnownRoutingSource kan door elkaar worden gebruikt met RoutingSource. Deze opsomming bevat de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund Ongeldig DeviceMessages TwinChangeEvents DeviceLifecycleEvents DeviceJobLifecycleEvents DeviceConnectionStateEvents
RoutingStorageContainerPropertiesEncoding	Definieert waarden voor RoutingStorageContainerPropertiesEncoding. KnownRoutingStorageContainerPropertiesEncoding kan door elkaar worden gebruikt met RoutingStorageContainerPropertiesEncoding. Deze opsomming bevat de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund Avro AvroDeflate JSON
TestResultStatus	Definieert waarden voor TestResultStatus. KnownTestResultStatus kan door elkaar worden gebruikt met TestResultStatus. Deze opsomming bevat de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund Ongedefinieerde Valse true

Enums

KnownAuthenticationType	Bekende waarden van AuthenticationType die de service accepteert.
KnownCapabilities	Bekende waarden van Mogelijkheden die de service accepteert.
KnownCreatedByType	Bekende waarden van CreatedByType die de service accepteert.
KnownDefaultAction	Bekende waarden van DefaultAction die de service accepteert.
KnownEndpointHealthStatus	Bekende waarden van EndpointHealthStatus die de service accepteert.
KnownIotHubReplicaRoleType	Bekende waarden van IotHubReplicaRoleType die de service accepteert.
KnownIotHubSku	Bekende waarden van IotHubSku die de service accepteert.
KnownJobType	Bekende waarden van JobType die de service accepteert.
KnownNetworkRuleIPAction	Bekende waarden van NetworkRuleIPAction die de service accepteert.
KnownPrivateLinkServiceConnectionStatus	Bekende waarden van PrivateLinkServiceConnectionStatus die de service accepteert.
KnownPublicNetworkAccess	Bekende waarden van PublicNetworkAccess die de service accepteert.
KnownRouteErrorSeverity	Bekende waarden van RouteErrorSeverity die de service accepteert.
KnownRoutingSource	Bekende waarden van RoutingSource die door de service worden geaccepteerd.
KnownRoutingStorageContainerPropertiesEncoding	Bekende waarden van RoutingStorageContainerPropertiesEncoding die de service accepteert.
KnownTestResultStatus	Bekende waarden van TestResultStatus die de service accepteert.

Functies

getContinuationToken(unknown)

Gezien de laatste .value die door de byPage iterator is geproduceerd, wordt een vervolgtoken geretourneerd dat kan worden gebruikt om later vanaf dat punt met paging te beginnen.

Functiedetails

getContinuationToken(unknown)

Gezien de laatste .value die door de byPage iterator is geproduceerd, wordt een vervolgtoken geretourneerd dat kan worden gebruikt om later vanaf dat punt met paging te beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

Een object dat vanuit een byPage iterator toegang krijgt value tot de IteratorResult.

Retouren

string | undefined

Het vervolgtoken dat tijdens toekomstige aanroepen kan worden doorgegeven aan byPage().