@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 Challenge 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 Cloud-zu-Gerät-Messagingeigenschaften von IoT Hub. |
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 |
Verwenden Sie zum Bereitstellen von Parametern beim Anfordern eines Exports aller Geräte im IoT Hub. |
FailoverInput |
Verwenden Sie zum Bereitstellen einer Failoverregion beim Anfordern eines manuellen Failovers für einen Hub. |
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-zu-Gerät-Nachrichten. |
GroupIdInformation |
Die Gruppeninformationen zum Erstellen eines privaten Endpunkts auf einem IotHub |
GroupIdInformationProperties |
Die Eigenschaften für ein Gruppeninformationsobjekt |
ImportDevicesRequest |
Verwenden Sie, um Parameter anzugeben, wenn Sie einen Import aller Geräte im Hub anfordern. |
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 Standorte, an denen eine Ressource bereitgestellt wird. |
IotHubManualFailoverHeaders |
Definiert Header für IotHub_manualFailover Vorgang. |
IotHubManualFailoverOptionalParams |
Optionale Parameter. |
IotHubNameAvailabilityInfo |
Die Eigenschaften, die angeben, ob ein bestimmter IoT Hub-Name verfügbar ist. |
IotHubProperties |
Die Eigenschaften eines IoT Hubs. |
IotHubQuotaMetricInfo |
Eigenschaften von Kontingentmetriken. |
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 Header 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 Messagingendpunkte, die von diesem IoT Hub verwendet werden. |
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, IoT Hub Vorgänge aufzulisten. Sie enthält eine Liste von Vorgängen und einen URL-Link zum Abrufen der nächsten Gruppe von Ergebnissen. |
Operations |
Schnittstelle, die einen Vorgang darstellt. |
OperationsListNextOptionalParams |
Optionale Parameter. |
OperationsListOptionalParams |
Optionale Parameter. |
PrivateEndpoint |
Die Eigenschaft des privaten Endpunkts einer privaten Endpunktverbindung |
PrivateEndpointConnection |
Die private Endpunktverbindung eines IotHub |
PrivateEndpointConnectionProperties |
Die Eigenschaften einer privaten Endpunktverbindung |
PrivateEndpointConnections |
Schnittstelle, die eine PrivateEndpointConnections darstellt. |
PrivateEndpointConnectionsDeleteHeaders |
Definiert Header für PrivateEndpointConnections_delete Vorgang. |
PrivateEndpointConnectionsDeleteOptionalParams |
Optionale Parameter. |
PrivateEndpointConnectionsGetOptionalParams |
Optionale Parameter. |
PrivateEndpointConnectionsListOptionalParams |
Optionale Parameter. |
PrivateEndpointConnectionsUpdateOptionalParams |
Optionale Parameter. |
PrivateLinkResources |
Die verfügbaren Private Link-Ressourcen für iotHub |
PrivateLinkResourcesGetOptionalParams |
Optionale Parameter. |
PrivateLinkResourcesListOptionalParams |
Optionale Parameter. |
PrivateLinkResourcesOperations |
Schnittstelle, die ein PrivateLinkResourcesOperations darstellt. |
PrivateLinkServiceConnectionState |
Der aktuelle Zustand einer Verbindung mit einem privaten Endpunkt |
RegistryStatistics |
Identitätsregistrierungsstatistiken. |
Resource |
Die allgemeinen Eigenschaften einer Azure-Ressource. |
ResourceProviderCommon |
Schnittstelle, die ein ResourceProviderCommon darstellt. |
ResourceProviderCommonGetSubscriptionQuotaOptionalParams |
Optionale Parameter. |
RouteCompilationError |
Kompilierungsfehler beim Auswerten der Route |
RouteErrorPosition |
Position, an der der Routenfehler aufgetreten ist |
RouteErrorRange |
Bereich von Routenfehlern |
RouteProperties |
Die Eigenschaften einer Routingregel, die Ihr IoT Hub verwendet, um Nachrichten an Endpunkte weiterzuleiten. |
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 ein benutzerdefinierter Endpunkt ist für alle Endpunkttypen für kostenlose Hubs zulässig. |
RoutingEventHubProperties |
Die Eigenschaften im Zusammenhang mit einem Event Hub-Endpunkt. |
RoutingMessage |
Weiterleiten von Nachrichten |
RoutingProperties |
Die Routingeigenschaften des IoT Hubs. Siehe: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
RoutingServiceBusQueueEndpointProperties |
Die Eigenschaften im Zusammenhang mit Service Bus-Warteschlangenendpunkttypen. |
RoutingServiceBusTopicEndpointProperties |
Die Eigenschaften im Zusammenhang mit Service Bus-Themenendpunkttypen. |
RoutingStorageContainerProperties |
Die Eigenschaften im Zusammenhang mit einem Speichercontainerendpunkt. |
RoutingTwin |
Eingabeparameter für Zwillingsverweis. Dies ist ein optionaler Parameter. |
RoutingTwinProperties | |
SharedAccessSignatureAuthorizationRule |
Die Eigenschaften einer IoT Hub-Richtlinie für den freigegebenen Zugriff. |
SharedAccessSignatureAuthorizationRuleListResult |
Die Liste der Shared Access-Richtlinien mit einem nächsten Link. |
StorageEndpointProperties |
Die Eigenschaften des Azure Storage-Endpunkts für den Dateiupload. |
SystemData |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
TagsResource |
Ein Container, der nur die Tags für eine Ressource enthält, sodass der Benutzer die Tags auf einer IoT Hub instance aktualisieren kann. |
TestAllRoutesInput |
Eingabe zum Testen aller Routen |
TestAllRoutesResult |
Ergebnis des Testens aller Routen |
TestRouteInput |
Eingabe zum Testen der Route |
TestRouteResult |
Testergebnis einer Route |
TestRouteResultDetails |
Detailliertes Ergebnis des Testens einer Route |
UserSubscriptionQuota |
Kontingentantwort für Benutzerabonnements |
UserSubscriptionQuotaListResult |
Json-serialisiertes Array der Benutzerabonnement-Kontingentantwort |
Typaliase
AccessRights |
Definiert Werte für AccessRights. |
AuthenticationType |
Definiert Werte für AuthenticationType. Vom Dienst unterstützte bekannte WertekeyBased |
Capabilities |
Definiert Werte für Funktionen. Vom Dienst unterstützte bekannte WerteNone |
CertificatesCreateOrUpdateResponse |
Enthält Antwortdaten für den CreateOrUpdate-Vorgang. |
CertificatesGenerateVerificationCodeResponse |
Enthält Antwortdaten für den Vorgang generateVerificationCode. |
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. Vom Dienst unterstützte bekannte WerteBenutzer |
DefaultAction |
Definiert Werte für DefaultAction. Vom Dienst unterstützte bekannte WerteDeny |
EndpointHealthStatus |
Definiert Werte für EndpointHealthStatus. Vom Dienst unterstützte bekannte WerteUnbekannt |
IotHubNameUnavailabilityReason |
Definiert Werte für IotHubNameUnavailabilityReason. |
IotHubReplicaRoleType |
Definiert Werte für IotHubReplicaRoleType. Vom Dienst unterstützte bekannte WertePrimäre |
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 Vorgang getEndpointHealthNext. |
IotHubResourceGetEndpointHealthResponse |
Enthält Antwortdaten für den getEndpointHealth-Vorgang. |
IotHubResourceGetEventHubConsumerGroupResponse |
Enthält Antwortdaten für den Vorgang getEventHubConsumerGroup. |
IotHubResourceGetJobResponse |
Enthält Antwortdaten für den getJob-Vorgang. |
IotHubResourceGetKeysForKeyNameResponse |
Enthält Antwortdaten für den Vorgang getKeysForKeyName. |
IotHubResourceGetQuotaMetricsNextResponse |
Enthält Antwortdaten für den Vorgang getQuotaMetricsNext. |
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 Vorgang listEventHubConsumerGroupsNext. |
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. Vom Dienst unterstützte bekannte WerteF1 |
IotHubSkuTier |
Definiert Werte für IotHubSkuTier. |
IpFilterActionType |
Definiert Werte für IpFilterActionType. |
JobStatus |
Definiert Werte für JobStatus. |
JobType |
Definiert Werte für JobType. Vom Dienst unterstützte bekannte WerteUnbekannt |
NetworkRuleIPAction |
Definiert Werte für NetworkRuleIPAction. Vom Dienst unterstützte bekannte WerteZulassen |
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. Vom Dienst unterstützte bekannte WerteAusstehend |
PublicNetworkAccess |
Definiert Werte für PublicNetworkAccess. Vom Dienst unterstützte bekannte WerteAktiviert |
ResourceIdentityType |
Definiert Werte für ResourceIdentityType. |
ResourceProviderCommonGetSubscriptionQuotaResponse |
Enthält Antwortdaten für den getSubscriptionQuota-Vorgang. |
RouteErrorSeverity |
Definiert Werte für RouteErrorSeverity. Vom Dienst unterstützte bekannte Werteerror |
RoutingSource |
Definiert Werte für RoutingSource. Vom Dienst unterstützte bekannte WerteUngültig |
RoutingStorageContainerPropertiesEncoding |
Definiert Werte für RoutingStorageContainerPropertiesEncoding. Vom Dienst unterstützte bekannte WerteAvro |
TestResultStatus |
Definiert Werte für TestResultStatus. Vom Dienst unterstützte bekannte Wertenicht definiert |
Enumerationen
KnownAuthenticationType |
Bekannte Werte von AuthenticationType , die der Dienst akzeptiert. |
KnownCapabilities |
Bekannte Werte von Funktionen , 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 |
Bei der letzten |
Details zur Funktion
getContinuationToken(unknown)
Bei der letzten .value
, die byPage
vom Iterator erzeugt wurde, gibt ein Fortsetzungstoken zurück, das verwendet werden kann, um die Paging von diesem Punkt später zu beginnen.
function getContinuationToken(page: unknown): string | undefined
Parameter
- page
-
unknown
Ein Objekt, das von einem byPage
Iterator auf iteratorResult zugreiftvalue
.
Gibt zurück
string | undefined
Das Fortsetzungstoken, das bei zukünftigen Aufrufen an byPage() übergeben werden kann.