Delen via


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

Klassen

IotHubClient

Interfaces

CertificateBodyDescription

Het X509-certificaat dat door JSON is geserialiseerd.

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 uitdaging die niet is uitgegeven voor de proof-Of-Possession-stroom.

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 eigenschappen voor cloud-naar-apparaat-berichten van 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.

EventHubConsumerGroupInfo

De eigenschappen van het Object EventHubConsumerGroupInfo.

EventHubConsumerGroupsListResult

De JSON-geserialiseerde matrix met namen van consumentengroepen die compatibel zijn met Event Hub met een volgende koppeling.

EventHubProperties

De eigenschappen van het ingerichte Event Hub-compatibele eindpunt dat wordt gebruikt door de IoT-hub.

ExportDevicesRequest

Gebruik dit om parameters op te geven bij het aanvragen van een export van alle apparaten in de IoT-hub.

FailoverInput

Gebruik dit om failoverregio te bieden 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.

ImportDevicesRequest

Gebruik dit om parameters op te geven bij het aanvragen van een import van alle apparaten in de hub.

IotHub

Interface die een IotHub vertegenwoordigt.

IotHubCapacity

Informatie over ioT Hub-capaciteit.

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.

IotHubManualFailoverOptionalParams

Optionele parameters.

IotHubNameAvailabilityInfo

De eigenschappen die aangeven of een bepaalde IoT-hubnaam beschikbaar is.

IotHubProperties

De eigenschappen van een IoT-hub.

IotHubPropertiesDeviceStreams

Het apparaat streamt eigenschappen van iothub.

IotHubQuotaMetricInfo

Eigenschappen van metrische quotumgegevens.

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.

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 Job Response.

JobResponseListResult

De JSON-geserialiseerde matrix van JobResponse-objecten met een volgende koppeling.

MatchedRoute

Routes die overeenkomen

MessagingEndpointProperties

De eigenschappen van de berichteneindpunten die door deze IoT-hub worden gebruikt.

Name

Naam van ioT Hub-type

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.

RegistryStatistics

Statistieken van identiteitsregisters.

Resource

De algemene eigenschappen van een Azure-resource.

ResourceProviderCommon

Interface die een ResourceProviderCommon vertegenwoordigt.

ResourceProviderCommonGetSubscriptionQuotaOptionalParams

Optionele parameters.

RouteCompilationError

Compilatiefout bij het evalueren van route

RouteErrorPosition

Positie waar de routefout is opgetreden

RouteErrorRange

Bereik van routefouten

RouteProperties

De eigenschappen van een routeringsregel die door uw IoT-hub wordt gebruikt om berichten naar eindpunten te routeren.

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 slechts 1 aangepast eindpunt is 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 van de Service Bus-wachtrij.

RoutingServiceBusTopicEndpointProperties

De eigenschappen met betrekking tot eindpunttypen voor 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 gedeeld toegangsbeleid voor 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.

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 testroute

TestRouteResult

Resultaat van het testen van één route

TestRouteResultDetails

Gedetailleerd resultaat van het testen van een route

UserSubscriptionQuota

Antwoord op quotum voor gebruikersabonnement

UserSubscriptionQuotaListResult

Json-geserialiseerde matrix met quotumrespons voor gebruikersabonnementen

Type-aliassen

AccessRights

Definieert waarden voor AccessRights.

Capabilities

Definieert waarden voor Capabilities.
KnownCapabilities kunnen door elkaar worden gebruikt met Capabilities, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Geen
DeviceManagement-

CertificatesCreateOrUpdateResponse

Bevat antwoordgegevens voor de createOrUpdate-bewerking.

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 verificatiebewerking.

EndpointHealthStatus

Definieert waarden voor EndpointHealthStatus.
KnownEndpointHealthStatus kan door elkaar worden gebruikt met EndpointHealthStatus, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

onbekende
gezonde
beschadigde
dode

IotHubNameUnavailabilityReason

Definieert waarden voor IotHubNameUnavailabilityReason.

IotHubReplicaRoleType

Definieert waarden voor IotHubReplicaRoleType.
KnownIotHubReplicaRoleType kan door elkaar worden gebruikt met IotHubReplicaRoleType, bevat dit enum de bekende waarden die de service ondersteunt.

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 createOrUpdate-bewerking.

IotHubResourceDeleteResponse

Bevat antwoordgegevens voor de verwijderbewerking.

IotHubResourceExportDevicesResponse

Bevat antwoordgegevens voor de exportDevices-bewerking.

IotHubResourceGetEndpointHealthNextResponse

Bevat antwoordgegevens voor de getEndpointHealthNext-bewerking.

IotHubResourceGetEndpointHealthResponse

Bevat antwoordgegevens voor de getEndpointHealth-bewerking.

IotHubResourceGetEventHubConsumerGroupResponse

Bevat antwoordgegevens voor de getEventHubConsumerGroup-bewerking.

IotHubResourceGetJobResponse

Bevat antwoordgegevens voor de getJob-bewerking.

IotHubResourceGetKeysForKeyNameResponse

Bevat antwoordgegevens voor de getKeysForKeyName-bewerking.

IotHubResourceGetQuotaMetricsNextResponse

Bevat antwoordgegevens voor de getQuotaMetricsNext-bewerking.

IotHubResourceGetQuotaMetricsResponse

Bevat antwoordgegevens voor de getQuotaMetrics-bewerking.

IotHubResourceGetResponse

Bevat antwoordgegevens voor de get-bewerking.

IotHubResourceGetStatsResponse

Bevat antwoordgegevens voor de getStats-bewerking.

IotHubResourceGetValidSkusNextResponse

Bevat antwoordgegevens voor de getValidSkusNext-bewerking.

IotHubResourceGetValidSkusResponse

Bevat antwoordgegevens voor de getValidSkus-bewerking.

IotHubResourceImportDevicesResponse

Bevat antwoordgegevens voor de importDevices-bewerking.

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 listBySubscription-bewerking.

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 bewerking listJobs.

IotHubResourceListKeysNextResponse

Bevat antwoordgegevens voor de bewerking listKeysNext.

IotHubResourceListKeysResponse

Bevat antwoordgegevens voor de bewerking listKeys.

IotHubResourceTestAllRoutesResponse

Bevat antwoordgegevens voor de testAllRoutes-bewerking.

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, bevat deze opsomming 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, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

onbekende
exporteren
importeren
back-up
readDeviceProperties-
writeDeviceProperties-
updateDeviceConfiguration-
rebootDevice-
factoryResetDevice-
firmwareUpdate-

OperationsListNextResponse

Bevat antwoordgegevens voor de listNext-bewerking.

OperationsListResponse

Bevat antwoordgegevens voor de lijstbewerking.

ResourceProviderCommonGetSubscriptionQuotaResponse

Bevat antwoordgegevens voor de getSubscriptionQuota-bewerking.

RouteErrorSeverity

Definieert waarden voor RouteErrorSeverity.
KnownRouteErrorSeverity kan door elkaar worden gebruikt met RouteErrorSeverity, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

fout
waarschuwing

RoutingSource

Definieert waarden voor RoutingSource.
KnownRoutingSource kan door elkaar worden gebruikt met RoutingSource, bevat deze opsomming de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

ongeldige
DeviceMessages-
TwinChangeEvents
DeviceLifecycleEvents
DeviceJobLifecycleEvents
DigitalTwinChangeEvents

RoutingStorageContainerPropertiesEncoding

Definieert waarden voor RoutingStorageContainerPropertiesEncoding.
KnownRoutingStorageContainerPropertiesEncoding kan door elkaar worden gebruikt met RoutingStorageContainerPropertiesEncoding, bevat deze opsomming 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, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

niet-gedefinieerde
onwaar
waar

Enums

KnownCapabilities

Bekende waarden van Capabilities 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.

KnownRouteErrorSeverity

Bekende waarden van RouteErrorSeverity die de service accepteert.

KnownRoutingSource

Bekende waarden van RoutingSource die de service accepteert.

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 geproduceerd door de byPage iterator, retourneert u een vervolgtoken dat kan worden gebruikt om later met paging te beginnen.

Functiedetails

getContinuationToken(unknown)

Gezien de laatste .value geproduceerd door de byPage iterator, retourneert u een vervolgtoken dat kan worden gebruikt om later met paging te beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

Een object opent value op iteratorResult vanuit een byPage iterator.

Retouren

string | undefined

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