@azure/arm-iothub package
Klasser
| IotHubClient |
Gränssnitt
| ArmIdentity | |
| ArmUserIdentity | |
| CertificateBodyDescription |
Det JSON-serialiserade X509-certifikatet. |
| CertificateDescription |
X509-certifikatet. |
| CertificateListDescription |
Den JSON-serialiserade matrisen med certifikatobjekt. |
| CertificateProperties |
Beskrivningen av ett X509 CA-certifikat. |
| CertificatePropertiesWithNonce |
Beskrivningen av ett X509 CA-certifikat inklusive den utmaning som utfärdats för flödet Proof-Of-Possession. |
| CertificateVerificationDescription |
JSON-serialiserat lövcertifikat |
| CertificateWithNonceDescription |
X509-certifikatet. |
| Certificates |
Gränssnitt som representerar ett certifikat. |
| CertificatesCreateOrUpdateOptionalParams |
Valfria parametrar. |
| CertificatesDeleteOptionalParams |
Valfria parametrar. |
| CertificatesGenerateVerificationCodeOptionalParams |
Valfria parametrar. |
| CertificatesGetOptionalParams |
Valfria parametrar. |
| CertificatesListByIotHubOptionalParams |
Valfria parametrar. |
| CertificatesVerifyOptionalParams |
Valfria parametrar. |
| CloudToDeviceProperties |
Meddelandeegenskaperna för IoT Hub från moln till enhet. |
| EndpointHealthData |
Hälsodata för en slutpunkt |
| EndpointHealthDataListResult |
Den JSON-serialiserade matrisen med EndpointHealthData-objekt med en nästa länk. |
| EnrichmentProperties |
Egenskaperna för en berikning som din IoT-hubb gäller för meddelanden som levereras till slutpunkter. |
| ErrorDetails |
Felinformation. |
| EventHubConsumerGroupBodyDescription |
EventHub-konsumentgruppen. |
| EventHubConsumerGroupInfo |
Egenskaperna för EventHubConsumerGroupInfo-objektet. |
| EventHubConsumerGroupName |
EventHub-konsumentgruppens namn. |
| EventHubConsumerGroupsListResult |
Den JSON-serialiserade matrisen med Event Hub-kompatibla konsumentgruppnamn med en nästa länk. |
| EventHubProperties |
Egenskaperna för den etablerade Event Hub-kompatibla slutpunkten som används av IoT-hubben. |
| ExportDevicesRequest |
Använd för att ange parametrar när du begär en export av alla enheter i IoT-hubben. |
| FailoverInput |
Använd för att ange redundansregion när du begär manuell redundans för en hubb. |
| FallbackRouteProperties |
Egenskaperna för återställningsvägen. IoT Hub använder dessa egenskaper när meddelanden dirigeras till återställningsslutpunkten. |
| FeedbackProperties |
Egenskaperna för feedbackkön för meddelanden från moln till enhet. |
| GroupIdInformation |
Gruppinformationen för att skapa en privat slutpunkt på en IotHub |
| GroupIdInformationProperties |
Egenskaperna för ett gruppinformationsobjekt |
| ImportDevicesRequest |
Använd för att ange parametrar när du begär en import av alla enheter i hubben. |
| IotHub |
Gränssnitt som representerar en IotHub. |
| IotHubCapacity |
Kapacitetsinformation för IoT Hub. |
| IotHubClientOptionalParams |
Valfria parametrar. |
| IotHubDescription |
Beskrivningen av IoT-hubben. |
| IotHubDescriptionListResult |
Den JSON-serialiserade matrisen med IotHubDescription-objekt med en nästa länk. |
| IotHubLocationDescription |
Offentlig representation av en av de platser där en resurs etableras. |
| IotHubManualFailoverHeaders |
Definierar rubriker för IotHub_manualFailover åtgärd. |
| IotHubManualFailoverOptionalParams |
Valfria parametrar. |
| IotHubNameAvailabilityInfo |
Egenskaperna som anger om ett angivet IoT-hubbnamn är tillgängligt. |
| IotHubProperties |
Egenskaperna för en IoT-hubb. |
| IotHubQuotaMetricInfo |
Egenskaper för kvotmått. |
| IotHubQuotaMetricInfoListResult |
Den JSON-serialiserade matrisen med IotHubQuotaMetricInfo-objekt med en nästa länk. |
| IotHubResource |
Gränssnitt som representerar en IotHubResource. |
| IotHubResourceCheckNameAvailabilityOptionalParams |
Valfria parametrar. |
| IotHubResourceCreateEventHubConsumerGroupOptionalParams |
Valfria parametrar. |
| IotHubResourceCreateOrUpdateOptionalParams |
Valfria parametrar. |
| IotHubResourceDeleteEventHubConsumerGroupOptionalParams |
Valfria parametrar. |
| IotHubResourceDeleteHeaders |
Definierar rubriker för IotHubResource_delete åtgärd. |
| IotHubResourceDeleteOptionalParams |
Valfria parametrar. |
| IotHubResourceExportDevicesOptionalParams |
Valfria parametrar. |
| IotHubResourceGetEndpointHealthNextOptionalParams |
Valfria parametrar. |
| IotHubResourceGetEndpointHealthOptionalParams |
Valfria parametrar. |
| IotHubResourceGetEventHubConsumerGroupOptionalParams |
Valfria parametrar. |
| IotHubResourceGetJobOptionalParams |
Valfria parametrar. |
| IotHubResourceGetKeysForKeyNameOptionalParams |
Valfria parametrar. |
| IotHubResourceGetOptionalParams |
Valfria parametrar. |
| IotHubResourceGetQuotaMetricsNextOptionalParams |
Valfria parametrar. |
| IotHubResourceGetQuotaMetricsOptionalParams |
Valfria parametrar. |
| IotHubResourceGetStatsOptionalParams |
Valfria parametrar. |
| IotHubResourceGetValidSkusNextOptionalParams |
Valfria parametrar. |
| IotHubResourceGetValidSkusOptionalParams |
Valfria parametrar. |
| IotHubResourceImportDevicesOptionalParams |
Valfria parametrar. |
| IotHubResourceListByResourceGroupNextOptionalParams |
Valfria parametrar. |
| IotHubResourceListByResourceGroupOptionalParams |
Valfria parametrar. |
| IotHubResourceListBySubscriptionNextOptionalParams |
Valfria parametrar. |
| IotHubResourceListBySubscriptionOptionalParams |
Valfria parametrar. |
| IotHubResourceListEventHubConsumerGroupsNextOptionalParams |
Valfria parametrar. |
| IotHubResourceListEventHubConsumerGroupsOptionalParams |
Valfria parametrar. |
| IotHubResourceListJobsNextOptionalParams |
Valfria parametrar. |
| IotHubResourceListJobsOptionalParams |
Valfria parametrar. |
| IotHubResourceListKeysNextOptionalParams |
Valfria parametrar. |
| IotHubResourceListKeysOptionalParams |
Valfria parametrar. |
| IotHubResourceTestAllRoutesOptionalParams |
Valfria parametrar. |
| IotHubResourceTestRouteOptionalParams |
Valfria parametrar. |
| IotHubResourceUpdateOptionalParams |
Valfria parametrar. |
| IotHubSkuDescription |
SKU-egenskaper. |
| IotHubSkuDescriptionListResult |
Den JSON-serialiserade matrisen med IotHubSkuDescription-objekt med en nästa länk. |
| IotHubSkuInfo |
Information om SKU:n för IoT-hubben. |
| IpFilterRule |
IP-filterreglerna för IoT-hubben. |
| JobResponse |
Egenskaperna för jobbsvarsobjektet. |
| JobResponseListResult |
Den JSON-serialiserade matrisen med JobResponse-objekt med en nästa länk. |
| ManagedIdentity |
Egenskaperna för den hanterade identiteten. |
| MatchedRoute |
Vägar som matchade |
| MessagingEndpointProperties |
Egenskaperna för de meddelandeslutpunkter som används av den här IoT-hubben. |
| Name |
Namn på Iot Hub-typ |
| NetworkRuleSetIpRule |
IP-regel som ska tillämpas som en del av nätverksregeluppsättningen |
| NetworkRuleSetProperties |
Egenskaper för nätverksregeluppsättning för IotHub |
| Operation |
REST API-åtgärd för IoT Hub |
| OperationDisplay |
Objektet som representerar åtgärden. |
| OperationInputs |
Indatavärden. |
| OperationListResult |
Resultatet av begäran om att lista IoT Hub-åtgärder. Den innehåller en lista över åtgärder och en URL-länk för att hämta nästa uppsättning resultat. |
| Operations |
Gränssnitt som representerar en operation. |
| OperationsListNextOptionalParams |
Valfria parametrar. |
| OperationsListOptionalParams |
Valfria parametrar. |
| PrivateEndpoint |
Egenskapen privat slutpunkt för en privat slutpunktsanslutning |
| PrivateEndpointConnection |
Den privata slutpunktsanslutningen för en IotHub |
| PrivateEndpointConnectionProperties |
Egenskaperna för en privat slutpunktsanslutning |
| PrivateEndpointConnections |
Gränssnitt som representerar en PrivateEndpointConnections. |
| PrivateEndpointConnectionsDeleteHeaders |
Definierar rubriker för PrivateEndpointConnections_delete åtgärd. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Valfria parametrar. |
| PrivateEndpointConnectionsGetOptionalParams |
Valfria parametrar. |
| PrivateEndpointConnectionsListOptionalParams |
Valfria parametrar. |
| PrivateEndpointConnectionsUpdateOptionalParams |
Valfria parametrar. |
| PrivateLinkResources |
Tillgängliga privata länkresurser för en IotHub |
| PrivateLinkResourcesGetOptionalParams |
Valfria parametrar. |
| PrivateLinkResourcesListOptionalParams |
Valfria parametrar. |
| PrivateLinkResourcesOperations |
Gränssnitt som representerar ett PrivateLinkResourcesOperations. |
| PrivateLinkServiceConnectionState |
Det aktuella tillståndet för en privat slutpunktsanslutning |
| RegistryStatistics |
Identitetsregisterstatistik. |
| Resource |
De vanliga egenskaperna för en Azure-resurs. |
| ResourceProviderCommon |
Gränssnitt som representerar en ResourceProviderCommon. |
| ResourceProviderCommonGetSubscriptionQuotaOptionalParams |
Valfria parametrar. |
| RouteCompilationError |
Kompileringsfel vid utvärdering av väg |
| RouteErrorPosition |
Position där routningsfelet inträffade |
| RouteErrorRange |
Intervall med routningsfel |
| RouteProperties |
Egenskaperna för en routningsregel som din IoT-hubb använder för att dirigera meddelanden till slutpunkter. |
| RoutingCosmosDBSqlApiProperties |
Egenskaperna som är relaterade till en cosmos DB sql-containerslutpunkt. |
| RoutingEndpoints |
Egenskaperna som är relaterade till de anpassade slutpunkter som din IoT Hub dirigerar meddelanden baserat på routningsreglerna. Högst 10 anpassade slutpunkter tillåts för alla slutpunktstyper för betalda hubbar och endast 1 anpassad slutpunkt tillåts för alla slutpunktstyper för kostnadsfria hubbar. |
| RoutingEventHubProperties |
Egenskaperna som är relaterade till en händelsehubbslutpunkt. |
| RoutingMessage |
Routningsmeddelande |
| RoutingProperties |
Routningsrelaterade egenskaper för IoT-hubben. Se: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging |
| RoutingServiceBusQueueEndpointProperties |
Egenskaper som är relaterade till service bus-köslutpunktstyper. |
| RoutingServiceBusTopicEndpointProperties |
Egenskaper som är relaterade till service bus-ämnesslutpunktstyper. |
| RoutingStorageContainerProperties |
Egenskaperna som är relaterade till en slutpunkt för lagringscontainer. |
| RoutingTwin |
Parameter för tvillingreferensindata. Det här är en valfri parameter |
| RoutingTwinProperties | |
| SharedAccessSignatureAuthorizationRule |
Egenskaperna för en princip för delad åtkomst i IoT Hub. |
| SharedAccessSignatureAuthorizationRuleListResult |
Listan över principer för delad åtkomst med en nästa länk. |
| StorageEndpointProperties |
Egenskaperna för Azure Storage-slutpunkten för filuppladdning. |
| SystemData |
Metadata som rör skapande och senaste ändring av resursen. |
| TagsResource |
En container som endast innehåller taggarna för en resurs, så att användaren kan uppdatera taggarna på en IoT Hub-instans. |
| TestAllRoutesInput |
Indata för testning av alla vägar |
| TestAllRoutesResult |
Resultat av testning av alla vägar |
| TestRouteInput |
Indata för testväg |
| TestRouteResult |
Resultat av testning av en väg |
| TestRouteResultDetails |
Detaljerat resultat av att testa en väg |
| UserSubscriptionQuota |
Svar på användarprenumerationskvot |
| UserSubscriptionQuotaListResult |
Json-serialiserad matris med svar på användarprenumerationskvot |
Typalias
| AccessRights |
Definierar värden för AccessRights. |
| AuthenticationType |
Definierar värden för AuthenticationType. Kända värden som stöds av tjänsten
keyBased |
| Capabilities |
Definierar värden för Funktioner. Kända värden som stöds av tjänsten
Ingen |
| CertificatesCreateOrUpdateResponse |
Innehåller svarsdata för åtgärden createOrUpdate. |
| CertificatesGenerateVerificationCodeResponse |
Innehåller svarsdata för åtgärden generateVerificationCode. |
| CertificatesGetResponse |
Innehåller svarsdata för get-åtgärden. |
| CertificatesListByIotHubResponse |
Innehåller svarsdata för åtgärden listByIotHub. |
| CertificatesVerifyResponse |
Innehåller svarsdata för verifieringsåtgärden. |
| CreatedByType |
Definierar värden för CreatedByType. Kända värden som stöds av tjänsten
användare |
| DefaultAction |
Definierar värden för DefaultAction. Kända värden som stöds av tjänsten
Neka |
| EndpointHealthStatus |
Definierar värden för EndpointHealthStatus. Kända värden som stöds av tjänsten
okänd |
| IotHubNameUnavailabilityReason |
Definierar värden för IotHubNameUnavailabilityReason. |
| IotHubReplicaRoleType |
Definierar värden för IotHubReplicaRoleType. Kända värden som stöds av tjänsten
primära |
| IotHubResourceCheckNameAvailabilityResponse |
Innehåller svarsdata för åtgärden checkNameAvailability. |
| IotHubResourceCreateEventHubConsumerGroupResponse |
Innehåller svarsdata för åtgärden createEventHubConsumerGroup. |
| IotHubResourceCreateOrUpdateResponse |
Innehåller svarsdata för åtgärden createOrUpdate. |
| IotHubResourceDeleteResponse |
Innehåller svarsdata för borttagningsåtgärden. |
| IotHubResourceExportDevicesResponse |
Innehåller svarsdata för exportEnhetsåtgärden. |
| IotHubResourceGetEndpointHealthNextResponse |
Innehåller svarsdata för åtgärden getEndpointHealthNext. |
| IotHubResourceGetEndpointHealthResponse |
Innehåller svarsdata för åtgärden getEndpointHealth. |
| IotHubResourceGetEventHubConsumerGroupResponse |
Innehåller svarsdata för åtgärden getEventHubConsumerGroup. |
| IotHubResourceGetJobResponse |
Innehåller svarsdata för getJob-åtgärden. |
| IotHubResourceGetKeysForKeyNameResponse |
Innehåller svarsdata för åtgärden getKeysForKeyName. |
| IotHubResourceGetQuotaMetricsNextResponse |
Innehåller svarsdata för åtgärden getQuotaMetricsNext. |
| IotHubResourceGetQuotaMetricsResponse |
Innehåller svarsdata för åtgärden getQuotaMetrics. |
| IotHubResourceGetResponse |
Innehåller svarsdata för get-åtgärden. |
| IotHubResourceGetStatsResponse |
Innehåller svarsdata för åtgärden getStats. |
| IotHubResourceGetValidSkusNextResponse |
Innehåller svarsdata för åtgärden getValidSkusNext. |
| IotHubResourceGetValidSkusResponse |
Innehåller svarsdata för åtgärden getValidSkus. |
| IotHubResourceImportDevicesResponse |
Innehåller svarsdata för åtgärden importEnhet. |
| IotHubResourceListByResourceGroupNextResponse |
Innehåller svarsdata för åtgärden listByResourceGroupNext. |
| IotHubResourceListByResourceGroupResponse |
Innehåller svarsdata för åtgärden listByResourceGroup. |
| IotHubResourceListBySubscriptionNextResponse |
Innehåller svarsdata för åtgärden listBySubscriptionNext. |
| IotHubResourceListBySubscriptionResponse |
Innehåller svarsdata för listBySubscription-åtgärden. |
| IotHubResourceListEventHubConsumerGroupsNextResponse |
Innehåller svarsdata för åtgärden listEventHubConsumerGroupsNext. |
| IotHubResourceListEventHubConsumerGroupsResponse |
Innehåller svarsdata för åtgärden listEventHubConsumerGroups. |
| IotHubResourceListJobsNextResponse |
Innehåller svarsdata för åtgärden listJobsNext. |
| IotHubResourceListJobsResponse |
Innehåller svarsdata för listJobs-åtgärden. |
| IotHubResourceListKeysNextResponse |
Innehåller svarsdata för åtgärden listKeysNext. |
| IotHubResourceListKeysResponse |
Innehåller svarsdata för åtgärden listKeys. |
| IotHubResourceTestAllRoutesResponse |
Innehåller svarsdata för testAllRoutes-åtgärden. |
| IotHubResourceTestRouteResponse |
Innehåller svarsdata för testRoute-åtgärden. |
| IotHubResourceUpdateResponse |
Innehåller svarsdata för uppdateringsåtgärden. |
| IotHubScaleType |
Definierar värden för IotHubScaleType. |
| IotHubSku |
Definierar värden för IotHubSku. Kända värden som stöds av tjänsten
F1 |
| IotHubSkuTier |
Definierar värden för IotHubSkuTier. |
| IpFilterActionType |
Definierar värden för IpFilterActionType. |
| JobStatus |
Definierar värden för JobStatus. |
| JobType |
Definierar värden för JobType. Kända värden som stöds av tjänsten
okänd |
| NetworkRuleIPAction |
Definierar värden för NetworkRuleIPAction. Kända värden som stöds av tjänstenTillåt |
| OperationsListNextResponse |
Innehåller svarsdata för listNästa åtgärden. |
| OperationsListResponse |
Innehåller svarsdata för liståtgärden. |
| PrivateEndpointConnectionsDeleteResponse |
Innehåller svarsdata för borttagningsåtgärden. |
| PrivateEndpointConnectionsGetResponse |
Innehåller svarsdata för get-åtgärden. |
| PrivateEndpointConnectionsListResponse |
Innehåller svarsdata för liståtgärden. |
| PrivateEndpointConnectionsUpdateResponse |
Innehåller svarsdata för uppdateringsåtgärden. |
| PrivateLinkResourcesGetResponse |
Innehåller svarsdata för get-åtgärden. |
| PrivateLinkResourcesListResponse |
Innehåller svarsdata för liståtgärden. |
| PrivateLinkServiceConnectionStatus |
Definierar värden för PrivateLinkServiceConnectionStatus. Kända värden som stöds av tjänsten
väntar på |
| PublicNetworkAccess |
Definierar värden för PublicNetworkAccess. Kända värden som stöds av tjänsten
aktiverat |
| ResourceIdentityType |
Definierar värden för ResourceIdentityType. |
| ResourceProviderCommonGetSubscriptionQuotaResponse |
Innehåller svarsdata för åtgärden getSubscriptionQuota. |
| RouteErrorSeverity |
Definierar värden för RouteErrorSeverity. Kända värden som stöds av tjänsten
fel |
| RoutingSource |
Definierar värden för RoutingSource. Kända värden som stöds av tjänsten
Ogiltig |
| RoutingStorageContainerPropertiesEncoding |
Definierar värden för RoutingStorageContainerPropertiesEncoding. Kända värden som stöds av tjänsten
Avro |
| TestResultStatus |
Definierar värden för TestResultStatus. Kända värden som stöds av tjänsten
odefinierad |
Uppräkningar
| KnownAuthenticationType |
Kända värden för AuthenticationType som tjänsten accepterar. |
| KnownCapabilities |
Kända värden för funktioner som tjänsten accepterar. |
| KnownCreatedByType |
Kända värden för CreatedByType- som tjänsten accepterar. |
| KnownDefaultAction |
Kända värden för DefaultAction som tjänsten accepterar. |
| KnownEndpointHealthStatus |
Kända värden för EndpointHealthStatus som tjänsten accepterar. |
| KnownIotHubReplicaRoleType |
Kända värden för IotHubReplicaRoleType som tjänsten accepterar. |
| KnownIotHubSku |
Kända värden för IotHubSku som tjänsten accepterar. |
| KnownJobType |
Kända värden för JobType- som tjänsten accepterar. |
| KnownNetworkRuleIPAction |
Kända värden för NetworkRuleIPAction som tjänsten accepterar. |
| KnownPrivateLinkServiceConnectionStatus |
Kända värden för PrivateLinkServiceConnectionStatus som tjänsten accepterar. |
| KnownPublicNetworkAccess |
Kända värden för PublicNetworkAccess som tjänsten accepterar. |
| KnownRouteErrorSeverity |
Kända värden för RouteErrorSeverity som tjänsten accepterar. |
| KnownRoutingSource |
Kända värden för RoutingSource som tjänsten accepterar. |
| KnownRoutingStorageContainerPropertiesEncoding |
Kända värden för RoutingStorageContainerPropertiesEncoding som tjänsten accepterar. |
| KnownTestResultStatus |
Kända värden för TestResultStatus som tjänsten accepterar. |
Funktioner
| get |
Med tanke på den senaste |
Funktionsinformation
getContinuationToken(unknown)
Med tanke på den senaste .value som skapades av iteratorn byPage returnerar en fortsättningstoken som kan användas för att börja söka från den punkten senare.
function getContinuationToken(page: unknown): string | undefined
Parametrar
- page
-
unknown
Ett objekt från att komma åt value på IteratorResult från en byPage iterator.
Returer
string | undefined
Fortsättningstoken som kan skickas till byPage() under framtida anrop.