@azure/arm-iothub package
Klassen
| IotHubClient |
Schnittstellen
| ArmIdentity | |
| ArmUserIdentity | |
| CertificateBodyDescription |
Das JSON-serialisierte X509-Zertifikat. |
| CertificateDescription |
Das X509-Zertifikat. |
| CertificateListDescription |
Das JSON-serialisierte Array von Zertifikatobjekten. |
| CertificateProperties |
Die Beschreibung eines X509-Zertifizierungsstellenzertifikats. |
| CertificatePropertiesWithNonce |
Die Beschreibung eines X509-Zertifizierungsstellenzertifikats einschließlich der Anforderungs nonce, die für den Proof-Of-Possession Flow ausgestellt wurde. |
| CertificateVerificationDescription |
Das JSON-serialisierte Blattzertifikat |
| CertificateWithNonceDescription |
Das X509-Zertifikat. |
| Certificates |
Schnittstelle, die ein Zertifikat darstellt. |
| CertificatesCreateOrUpdateOptionalParams |
Optionale Parameter. |
| CertificatesDeleteOptionalParams |
Optionale Parameter. |
| CertificatesGenerateVerificationCodeOptionalParams |
Optionale Parameter. |
| CertificatesGetOptionalParams |
Optionale Parameter. |
| CertificatesListByIotHubOptionalParams |
Optionale Parameter. |
| CertificatesVerifyOptionalParams |
Optionale Parameter. |
| CloudToDeviceProperties |
Die IoT-Hub-Cloud-to-Device-Messaging-Eigenschaften. |
| EndpointHealthData |
Die Integritätsdaten für einen Endpunkt |
| EndpointHealthDataListResult |
Das JSON-serialisierte Array von EndpointHealthData-Objekten mit einem nächsten Link. |
| EnrichmentProperties |
Die Eigenschaften einer Anreicherung, die Ihr IoT-Hub auf Nachrichten an Endpunkte anwendet. |
| ErrorDetails |
Fehlerdetails. |
| EventHubConsumerGroupBodyDescription |
Die EventHub-Consumergruppe. |
| EventHubConsumerGroupInfo |
Die Eigenschaften des EventHubConsumerGroupInfo -Objekts. |
| EventHubConsumerGroupName |
Der Name der EventHub-Consumergruppe. |
| EventHubConsumerGroupsListResult |
Das JSON-serialisierte Array von Event Hub-kompatiblen Consumergruppennamen mit einem nächsten Link. |
| EventHubProperties |
Die Eigenschaften des bereitgestellten Event Hub-kompatiblen Endpunkts, der vom IoT-Hub verwendet wird. |
| ExportDevicesRequest |
Wird verwendet, um Parameter bereitzustellen, wenn ein Export aller Geräte im IoT-Hub angefordert wird. |
| FailoverInput |
Wird verwendet, um Failoverregion bereitzustellen, wenn manuelles Failover für einen Hub angefordert wird. |
| FallbackRouteProperties |
Die Eigenschaften der Fallbackroute. IoT Hub verwendet diese Eigenschaften, wenn nachrichten an den Fallbackendpunkt weitergeleitet werden. |
| FeedbackProperties |
Die Eigenschaften der Feedbackwarteschlange für Cloud-to-Device-Nachrichten. |
| GroupIdInformation |
Die Gruppeninformationen zum Erstellen eines privaten Endpunkts auf einem IotHub |
| GroupIdInformationProperties |
Die Eigenschaften für ein Gruppeninformationsobjekt |
| ImportDevicesRequest |
Wird verwendet, um Parameter bereitzustellen, wenn ein Import aller Geräte im Hub angefordert wird. |
| IotHub |
Schnittstelle, die einen IotHub darstellt. |
| IotHubCapacity |
IoT Hub-Kapazitätsinformationen. |
| IotHubClientOptionalParams |
Optionale Parameter. |
| IotHubDescription |
Die Beschreibung des IoT-Hubs. |
| IotHubDescriptionListResult |
Das JSON-serialisierte Array von IotHubDescription-Objekten mit einem nächsten Link. |
| IotHubLocationDescription |
Öffentliche Darstellung eines der Speicherorte, an denen eine Ressource bereitgestellt wird. |
| IotHubManualFailoverHeaders |
Definiert Kopfzeilen für IotHub_manualFailover Vorgang. |
| IotHubManualFailoverOptionalParams |
Optionale Parameter. |
| IotHubNameAvailabilityInfo |
Die Eigenschaften, die angeben, ob ein bestimmter IoT-Hubname verfügbar ist. |
| IotHubProperties |
Die Eigenschaften eines IoT-Hubs. |
| IotHubQuotaMetricInfo |
Kontingentmetrikeneigenschaften. |
| IotHubQuotaMetricInfoListResult |
Das JSON-serialisierte Array von IotHubQuotaMetricInfo-Objekten mit einem nächsten Link. |
| IotHubResource |
Schnittstelle, die eine IotHubResource darstellt. |
| IotHubResourceCheckNameAvailabilityOptionalParams |
Optionale Parameter. |
| IotHubResourceCreateEventHubConsumerGroupOptionalParams |
Optionale Parameter. |
| IotHubResourceCreateOrUpdateOptionalParams |
Optionale Parameter. |
| IotHubResourceDeleteEventHubConsumerGroupOptionalParams |
Optionale Parameter. |
| IotHubResourceDeleteHeaders |
Definiert Kopfzeilen für IotHubResource_delete Vorgang. |
| IotHubResourceDeleteOptionalParams |
Optionale Parameter. |
| IotHubResourceExportDevicesOptionalParams |
Optionale Parameter. |
| IotHubResourceGetEndpointHealthNextOptionalParams |
Optionale Parameter. |
| IotHubResourceGetEndpointHealthOptionalParams |
Optionale Parameter. |
| IotHubResourceGetEventHubConsumerGroupOptionalParams |
Optionale Parameter. |
| IotHubResourceGetJobOptionalParams |
Optionale Parameter. |
| IotHubResourceGetKeysForKeyNameOptionalParams |
Optionale Parameter. |
| IotHubResourceGetOptionalParams |
Optionale Parameter. |
| IotHubResourceGetQuotaMetricsNextOptionalParams |
Optionale Parameter. |
| IotHubResourceGetQuotaMetricsOptionalParams |
Optionale Parameter. |
| IotHubResourceGetStatsOptionalParams |
Optionale Parameter. |
| IotHubResourceGetValidSkusNextOptionalParams |
Optionale Parameter. |
| IotHubResourceGetValidSkusOptionalParams |
Optionale Parameter. |
| IotHubResourceImportDevicesOptionalParams |
Optionale Parameter. |
| IotHubResourceListByResourceGroupNextOptionalParams |
Optionale Parameter. |
| IotHubResourceListByResourceGroupOptionalParams |
Optionale Parameter. |
| IotHubResourceListBySubscriptionNextOptionalParams |
Optionale Parameter. |
| IotHubResourceListBySubscriptionOptionalParams |
Optionale Parameter. |
| IotHubResourceListEventHubConsumerGroupsNextOptionalParams |
Optionale Parameter. |
| IotHubResourceListEventHubConsumerGroupsOptionalParams |
Optionale Parameter. |
| IotHubResourceListJobsNextOptionalParams |
Optionale Parameter. |
| IotHubResourceListJobsOptionalParams |
Optionale Parameter. |
| IotHubResourceListKeysNextOptionalParams |
Optionale Parameter. |
| IotHubResourceListKeysOptionalParams |
Optionale Parameter. |
| IotHubResourceTestAllRoutesOptionalParams |
Optionale Parameter. |
| IotHubResourceTestRouteOptionalParams |
Optionale Parameter. |
| IotHubResourceUpdateOptionalParams |
Optionale Parameter. |
| IotHubSkuDescription |
SKU-Eigenschaften. |
| IotHubSkuDescriptionListResult |
Das JSON-serialisierte Array von IotHubSkuDescription-Objekten mit einem nächsten Link. |
| IotHubSkuInfo |
Informationen zur SKU des IoT-Hubs. |
| IpFilterRule |
Die IP-Filterregeln für den IoT-Hub. |
| JobResponse |
Die Eigenschaften des Auftragsantwortobjekts. |
| JobResponseListResult |
Das JSON-serialisierte Array von JobResponse-Objekten mit einem nächsten Link. |
| ManagedIdentity |
Die Eigenschaften der verwalteten Identität. |
| MatchedRoute |
Routen, die übereinstimmen |
| MessagingEndpointProperties |
Die Eigenschaften der von diesem IoT-Hub verwendeten Messaging-Endpunkte. |
| Name |
Name des Iot Hub-Typs |
| NetworkRuleSetIpRule |
IP-Regel, die als Teil des Netzwerkregelsatzes angewendet werden soll |
| NetworkRuleSetProperties |
Netzwerkregelsatzeigenschaften von IotHub |
| Operation |
IoT Hub REST-API-Vorgang |
| OperationDisplay |
Das Objekt, das den Vorgang darstellt. |
| OperationInputs |
Eingabewerte. |
| OperationListResult |
Ergebnis der Anforderung zum Auflisten von IoT Hub-Vorgängen. Sie enthält eine Liste von Vorgängen und einen URL-Link, um den nächsten Satz von Ergebnissen abzurufen. |
| Operations |
Schnittstelle, die eine Operation darstellt. |
| OperationsListNextOptionalParams |
Optionale Parameter. |
| OperationsListOptionalParams |
Optionale Parameter. |
| PrivateEndpoint |
Die private Endpunkteigenschaft einer privaten Endpunktverbindung |
| PrivateEndpointConnection |
Die private Endpunktverbindung eines IotHub |
| PrivateEndpointConnectionProperties |
Die Eigenschaften einer privaten Endpunktverbindung |
| PrivateEndpointConnections |
Schnittstelle, die eine PrivateEndpointConnections darstellt. |
| PrivateEndpointConnectionsDeleteHeaders |
Definiert Kopfzeilen für PrivateEndpointConnections_delete Vorgang. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Optionale Parameter. |
| PrivateEndpointConnectionsGetOptionalParams |
Optionale Parameter. |
| PrivateEndpointConnectionsListOptionalParams |
Optionale Parameter. |
| PrivateEndpointConnectionsUpdateOptionalParams |
Optionale Parameter. |
| PrivateLinkResources |
Die verfügbaren privaten Linkressourcen für einen IotHub |
| PrivateLinkResourcesGetOptionalParams |
Optionale Parameter. |
| PrivateLinkResourcesListOptionalParams |
Optionale Parameter. |
| PrivateLinkResourcesOperations |
Schnittstelle, die eine PrivateLinkResourcesOperations darstellt. |
| PrivateLinkServiceConnectionState |
Der aktuelle Status einer privaten Endpunktverbindung |
| RegistryStatistics |
Identitätsregistrierungsstatistiken. |
| Resource |
Die allgemeinen Eigenschaften einer Azure-Ressource. |
| ResourceProviderCommon |
Schnittstelle, die einen ResourceProviderCommon darstellt. |
| ResourceProviderCommonGetSubscriptionQuotaOptionalParams |
Optionale Parameter. |
| RouteCompilationError |
Kompilierungsfehler beim Auswerten der Route |
| RouteErrorPosition |
Position, an der der Routenfehler aufgetreten ist |
| RouteErrorRange |
Bereich der Routenfehler |
| RouteProperties |
Die Eigenschaften einer Routingregel, die Ihr IoT-Hub zum Weiterleiten von Nachrichten an Endpunkte verwendet. |
| RoutingCosmosDBSqlApiProperties |
Die Eigenschaften im Zusammenhang mit einem Cosmos DB SQL-Containerendpunkt. |
| RoutingEndpoints |
Die Eigenschaften im Zusammenhang mit den benutzerdefinierten Endpunkten, an die Ihr IoT-Hub Nachrichten basierend auf den Routingregeln weiterleitet. Maximal 10 benutzerdefinierte Endpunkte sind für alle Endpunkttypen für kostenpflichtige Hubs zulässig, und nur 1 benutzerdefinierter Endpunkt ist für alle Endpunkttypen für kostenlose Hubs zulässig. |
| RoutingEventHubProperties |
Die Eigenschaften im Zusammenhang mit einem Event Hub-Endpunkt. |
| RoutingMessage |
Routingnachricht |
| RoutingProperties |
Die routingbezogenen Eigenschaften des IoT-Hubs. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
| RoutingServiceBusQueueEndpointProperties |
Die Eigenschaften im Zusammenhang mit Dienstenbus-Warteschlangenendpunkttypen. |
| RoutingServiceBusTopicEndpointProperties |
Die Eigenschaften im Zusammenhang mit Dienstenbus-Themenendpunkttypen. |
| RoutingStorageContainerProperties |
Die Eigenschaften im Zusammenhang mit einem Speichercontainerendpunkt. |
| RoutingTwin |
Zwillingsreferenz-Eingabeparameter. Dies ist ein optionaler Parameter. |
| RoutingTwinProperties | |
| SharedAccessSignatureAuthorizationRule |
Die Eigenschaften einer IoT-Hub-Richtlinie für den freigegebenen Zugriff. |
| SharedAccessSignatureAuthorizationRuleListResult |
Die Liste der Richtlinien für den freigegebenen Zugriff mit einem nächsten Link. |
| StorageEndpointProperties |
Die Eigenschaften des Azure Storage-Endpunkts für den Dateiupload. |
| SystemData |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
| TagsResource |
Ein Container, der nur die Tags für eine Ressource enthält, sodass der Benutzer die Tags in einer IoT Hub-Instanz aktualisieren kann. |
| TestAllRoutesInput |
Eingabe zum Testen aller Routen |
| TestAllRoutesResult |
Ergebnis des Testens aller Routen |
| TestRouteInput |
Eingabe für testroute |
| TestRouteResult |
Ergebnis des Testens einer Route |
| TestRouteResultDetails |
Detailliertes Ergebnis des Testens einer Route |
| UserSubscriptionQuota |
Antwort auf das Benutzerabonnementkontingent |
| UserSubscriptionQuotaListResult |
Json-serialisiertes Array der Antwort auf Benutzerabonnementkontingente |
Typaliase
| AccessRights |
Definiert Werte für AccessRights. |
| AuthenticationType |
Definiert Werte für AuthenticationType. Bekannte Werte, die vom Dienst unterstützt werden
keyBased- |
| Capabilities |
Definiert Werte für Funktionen. Bekannte Werte, die vom Dienst unterstützt werden
Keine |
| CertificatesCreateOrUpdateResponse |
Enthält Antwortdaten für den createOrUpdate-Vorgang. |
| CertificatesGenerateVerificationCodeResponse |
Enthält Antwortdaten für den generateVerificationCode-Vorgang. |
| CertificatesGetResponse |
Enthält Antwortdaten für den Get-Vorgang. |
| CertificatesListByIotHubResponse |
Enthält Antwortdaten für den listByIotHub-Vorgang. |
| CertificatesVerifyResponse |
Enthält Antwortdaten für den Überprüfungsvorgang. |
| CreatedByType |
Definiert Werte für CreatedByType. Bekannte Werte, die vom Dienst unterstützt werden
|
| DefaultAction |
Definiert Werte für DefaultAction. Bekannte Werte, die vom Dienst unterstützt werden
verweigern |
| EndpointHealthStatus |
Definiert Werte für EndpointHealthStatus. Bekannte Werte, die vom Dienst unterstützt werden
unbekannten |
| IotHubNameUnavailabilityReason |
Definiert Werte für IotHubNameUnavailabilityReason. |
| IotHubReplicaRoleType |
Definiert Werte für IotHubReplicaRoleType. Bekannte Werte, die vom Dienst unterstützt werden
primären |
| IotHubResourceCheckNameAvailabilityResponse |
Enthält Antwortdaten für den CheckNameAvailability-Vorgang. |
| IotHubResourceCreateEventHubConsumerGroupResponse |
Enthält Antwortdaten für den createEventHubConsumerGroup-Vorgang. |
| IotHubResourceCreateOrUpdateResponse |
Enthält Antwortdaten für den createOrUpdate-Vorgang. |
| IotHubResourceDeleteResponse |
Enthält Antwortdaten für den Löschvorgang. |
| IotHubResourceExportDevicesResponse |
Enthält Antwortdaten für den ExportDevices-Vorgang. |
| IotHubResourceGetEndpointHealthNextResponse |
Enthält Antwortdaten für den getEndpointHealthNext-Vorgang. |
| IotHubResourceGetEndpointHealthResponse |
Enthält Antwortdaten für den getEndpointHealth-Vorgang. |
| IotHubResourceGetEventHubConsumerGroupResponse |
Enthält Antwortdaten für den getEventHubConsumerGroup-Vorgang. |
| IotHubResourceGetJobResponse |
Enthält Antwortdaten für den getJob-Vorgang. |
| IotHubResourceGetKeysForKeyNameResponse |
Enthält Antwortdaten für den getKeysForKeyName-Vorgang. |
| IotHubResourceGetQuotaMetricsNextResponse |
Enthält Antwortdaten für den getQuotaMetricsNext-Vorgang. |
| IotHubResourceGetQuotaMetricsResponse |
Enthält Antwortdaten für den getQuotaMetrics-Vorgang. |
| IotHubResourceGetResponse |
Enthält Antwortdaten für den Get-Vorgang. |
| IotHubResourceGetStatsResponse |
Enthält Antwortdaten für den getStats-Vorgang. |
| IotHubResourceGetValidSkusNextResponse |
Enthält Antwortdaten für den getValidSkusNext-Vorgang. |
| IotHubResourceGetValidSkusResponse |
Enthält Antwortdaten für den getValidSkus-Vorgang. |
| IotHubResourceImportDevicesResponse |
Enthält Antwortdaten für den importDevices-Vorgang. |
| IotHubResourceListByResourceGroupNextResponse |
Enthält Antwortdaten für den ListByResourceGroupNext-Vorgang. |
| IotHubResourceListByResourceGroupResponse |
Enthält Antwortdaten für den listByResourceGroup-Vorgang. |
| IotHubResourceListBySubscriptionNextResponse |
Enthält Antwortdaten für den ListBySubscriptionNext-Vorgang. |
| IotHubResourceListBySubscriptionResponse |
Enthält Antwortdaten für den ListBySubscription-Vorgang. |
| IotHubResourceListEventHubConsumerGroupsNextResponse |
Enthält Antwortdaten für den listEventHubConsumerGroupsNext-Vorgang. |
| IotHubResourceListEventHubConsumerGroupsResponse |
Enthält Antwortdaten für den listEventHubConsumerGroups-Vorgang. |
| IotHubResourceListJobsNextResponse |
Enthält Antwortdaten für den listJobsNext-Vorgang. |
| IotHubResourceListJobsResponse |
Enthält Antwortdaten für den listJobs-Vorgang. |
| IotHubResourceListKeysNextResponse |
Enthält Antwortdaten für den listKeysNext-Vorgang. |
| IotHubResourceListKeysResponse |
Enthält Antwortdaten für den listKeys-Vorgang. |
| IotHubResourceTestAllRoutesResponse |
Enthält Antwortdaten für den TestAllRoutes-Vorgang. |
| IotHubResourceTestRouteResponse |
Enthält Antwortdaten für den testRoute-Vorgang. |
| IotHubResourceUpdateResponse |
Enthält Antwortdaten für den Aktualisierungsvorgang. |
| IotHubScaleType |
Definiert Werte für IotHubScaleType. |
| IotHubSku |
Definiert Werte für IotHubSku. Bekannte Werte, die vom Dienst unterstützt werden
F1- |
| IotHubSkuTier |
Definiert Werte für IotHubSkuTier. |
| IpFilterActionType |
Definiert Werte für IpFilterActionType. |
| JobStatus |
Definiert Werte für JobStatus. |
| JobType |
Definiert Werte für JobType. Bekannte Werte, die vom Dienst unterstützt werden
unbekannten |
| NetworkRuleIPAction |
Definiert Werte für NetworkRuleIPAction. Bekannte Werte, die vom Dienst unterstützt werdenzulassen |
| OperationsListNextResponse |
Enthält Antwortdaten für den listNext-Vorgang. |
| OperationsListResponse |
Enthält Antwortdaten für den Listenvorgang. |
| PrivateEndpointConnectionsDeleteResponse |
Enthält Antwortdaten für den Löschvorgang. |
| PrivateEndpointConnectionsGetResponse |
Enthält Antwortdaten für den Get-Vorgang. |
| PrivateEndpointConnectionsListResponse |
Enthält Antwortdaten für den Listenvorgang. |
| PrivateEndpointConnectionsUpdateResponse |
Enthält Antwortdaten für den Aktualisierungsvorgang. |
| PrivateLinkResourcesGetResponse |
Enthält Antwortdaten für den Get-Vorgang. |
| PrivateLinkResourcesListResponse |
Enthält Antwortdaten für den Listenvorgang. |
| PrivateLinkServiceConnectionStatus |
Definiert Werte für PrivateLinkServiceConnectionStatus. Bekannte Werte, die vom Dienst unterstützt werden
ausstehende |
| PublicNetworkAccess |
Definiert Werte für PublicNetworkAccess. Bekannte Werte, die vom Dienst unterstützt werden
Aktivierte |
| ResourceIdentityType |
Definiert Werte für ResourceIdentityType. |
| ResourceProviderCommonGetSubscriptionQuotaResponse |
Enthält Antwortdaten für den getSubscriptionQuota-Vorgang. |
| RouteErrorSeverity |
Definiert Werte für RouteErrorSeverity. Bekannte Werte, die vom Dienst unterstützt werden
Fehler |
| RoutingSource |
Definiert Werte für RoutingSource. Bekannte Werte, die vom Dienst unterstützt werden
Ungültige |
| RoutingStorageContainerPropertiesEncoding |
Definiert Werte für RoutingStorageContainerPropertiesEncoding. Bekannte Werte, die vom Dienst unterstützt werden
Avro |
| TestResultStatus |
Definiert Werte für TestResultStatus. Bekannte Werte, die vom Dienst unterstützt werden
nicht definierten |
Enumerationen
| KnownAuthenticationType |
Bekannte Werte von AuthenticationType, die der Dienst akzeptiert. |
| KnownCapabilities |
Bekannte Werte von Capabilities, die der Dienst akzeptiert. |
| KnownCreatedByType |
Bekannte Werte von CreatedByType, die der Dienst akzeptiert. |
| KnownDefaultAction |
Bekannte Werte von DefaultAction-, die der Dienst akzeptiert. |
| KnownEndpointHealthStatus |
Bekannte Werte von EndpointHealthStatus, die der Dienst akzeptiert. |
| KnownIotHubReplicaRoleType |
Bekannte Werte von IotHubReplicaRoleType, die der Dienst akzeptiert. |
| KnownIotHubSku |
Bekannte Werte von IotHubSku, die der Dienst akzeptiert. |
| KnownJobType |
Bekannte Werte von JobType, die der Dienst akzeptiert. |
| KnownNetworkRuleIPAction |
Bekannte Werte von NetworkRuleIPAction, die der Dienst akzeptiert. |
| KnownPrivateLinkServiceConnectionStatus |
Bekannte Werte von PrivateLinkServiceConnectionStatus, die der Dienst akzeptiert. |
| KnownPublicNetworkAccess |
Bekannte Werte von PublicNetworkAccess, die der Dienst akzeptiert. |
| KnownRouteErrorSeverity |
Bekannte Werte von RouteErrorSeverity, die der Dienst akzeptiert. |
| KnownRoutingSource |
Bekannte Werte von RoutingSource-, die der Dienst akzeptiert. |
| KnownRoutingStorageContainerPropertiesEncoding |
Bekannte Werte von RoutingStorageContainerPropertiesEncoding, die der Dienst akzeptiert. |
| KnownTestResultStatus |
Bekannte Werte von TestResultStatus, die der Dienst akzeptiert. |
Functions
| get |
Gibt aufgrund der letzten |
Details zur Funktion
getContinuationToken(unknown)
Gibt aufgrund der letzten .value, die vom byPage Iterator erstellt wurde, ein Fortsetzungstoken zurück, das verwendet werden kann, um mit dem Paging ab diesem Zeitpunkt zu beginnen.
function getContinuationToken(page: unknown): string | undefined
Parameter
- page
-
unknown
Ein Objekt vom Zugriff auf value im IteratorResult aus einem byPage Iterator.
Gibt zurück
string | undefined
Das Fortsetzungstoken, das während zukünftiger Aufrufe an byPage() übergeben werden kann.