@azure/arm-iothub package

Clases

IotHubClient

Interfaces

ArmIdentity
ArmUserIdentity
CertificateBodyDescription	Certificado X509 serializado por JSON.
CertificateDescription	Certificado X509.
CertificateListDescription	Matriz serializada por JSON de objetos Certificate.
CertificateProperties	Descripción de un certificado de entidad de certificación X509.
CertificatePropertiesWithNonce	Descripción de un certificado de entidad de certificación X509, incluido el desafío nonce emitido para el flujo proof-Of-Possession.
CertificateVerificationDescription	El certificado hoja serializado por JSON
CertificateWithNonceDescription	Certificado X509.
Certificates	Interfaz que representa un certificado.
CertificatesCreateOrUpdateOptionalParams	Parámetros opcionales.
CertificatesDeleteOptionalParams	Parámetros opcionales.
CertificatesGenerateVerificationCodeOptionalParams	Parámetros opcionales.
CertificatesGetOptionalParams	Parámetros opcionales.
CertificatesListByIotHubOptionalParams	Parámetros opcionales.
CertificatesVerifyOptionalParams	Parámetros opcionales.
CloudToDeviceProperties	Las propiedades de mensajería de nube a dispositivo de IoT Hub.
EndpointHealthData	Los datos de mantenimiento de un punto de conexión
EndpointHealthDataListResult	Matriz serializada por JSON de objetos EndpointHealthData con un vínculo siguiente.
EnrichmentProperties	Las propiedades de un enriquecimiento que el centro de IoT aplica a los mensajes entregados a los puntos de conexión.
ErrorDetails	Detalles del error.
EventHubConsumerGroupBodyDescription	El grupo de consumidores de EventHub.
EventHubConsumerGroupInfo	Propiedades del objeto EventHubConsumerGroupInfo.
EventHubConsumerGroupName	Nombre del grupo de consumidores de EventHub.
EventHubConsumerGroupsListResult	Matriz serializada por JSON de nombres de grupos de consumidores compatibles con Event Hubs con un vínculo siguiente.
EventHubProperties	Las propiedades del punto de conexión compatible con Event Hubs aprovisionado que usa IoT Hub.
ExportDevicesRequest	Use para proporcionar parámetros al solicitar una exportación de todos los dispositivos del centro de IoT.
FailoverInput	Use para proporcionar la región de conmutación por error al solicitar conmutación por error manual para un centro.
FallbackRouteProperties	Propiedades de la ruta de reserva. IoT Hub usa estas propiedades cuando enruta mensajes al punto de conexión de reserva.
FeedbackProperties	Las propiedades de la cola de comentarios para los mensajes de nube a dispositivo.
GroupIdInformation	Información de grupo para crear un punto de conexión privado en un IotHub
GroupIdInformationProperties	Propiedades de un objeto de información de grupo
ImportDevicesRequest	Use para proporcionar parámetros al solicitar una importación de todos los dispositivos del centro.
IotHub	Interfaz que representa un IotHub.
IotHubCapacity	Información de capacidad de IoT Hub.
IotHubClientOptionalParams	Parámetros opcionales.
IotHubDescription	Descripción del centro de IoT.
IotHubDescriptionListResult	Matriz serializada por JSON de objetos IotHubDescription con un vínculo siguiente.
IotHubLocationDescription	Representación pública de una de las ubicaciones donde se aprovisiona un recurso.
IotHubManualFailoverHeaders	Define encabezados para IotHub_manualFailover operación.
IotHubManualFailoverOptionalParams	Parámetros opcionales.
IotHubNameAvailabilityInfo	Propiedades que indican si hay disponible un nombre de centro de IoT determinado.
IotHubProperties	Las propiedades de un centro de IoT.
IotHubQuotaMetricInfo	Propiedades de métricas de cuota.
IotHubQuotaMetricInfoListResult	Matriz serializada por JSON de objetos IotHubQuotaMetricInfo con un vínculo siguiente.
IotHubResource	Interfaz que representa un IotHubResource.
IotHubResourceCheckNameAvailabilityOptionalParams	Parámetros opcionales.
IotHubResourceCreateEventHubConsumerGroupOptionalParams	Parámetros opcionales.
IotHubResourceCreateOrUpdateOptionalParams	Parámetros opcionales.
IotHubResourceDeleteEventHubConsumerGroupOptionalParams	Parámetros opcionales.
IotHubResourceDeleteHeaders	Define encabezados para IotHubResource_delete operación.
IotHubResourceDeleteOptionalParams	Parámetros opcionales.
IotHubResourceExportDevicesOptionalParams	Parámetros opcionales.
IotHubResourceGetEndpointHealthNextOptionalParams	Parámetros opcionales.
IotHubResourceGetEndpointHealthOptionalParams	Parámetros opcionales.
IotHubResourceGetEventHubConsumerGroupOptionalParams	Parámetros opcionales.
IotHubResourceGetJobOptionalParams	Parámetros opcionales.
IotHubResourceGetKeysForKeyNameOptionalParams	Parámetros opcionales.
IotHubResourceGetOptionalParams	Parámetros opcionales.
IotHubResourceGetQuotaMetricsNextOptionalParams	Parámetros opcionales.
IotHubResourceGetQuotaMetricsOptionalParams	Parámetros opcionales.
IotHubResourceGetStatsOptionalParams	Parámetros opcionales.
IotHubResourceGetValidSkusNextOptionalParams	Parámetros opcionales.
IotHubResourceGetValidSkusOptionalParams	Parámetros opcionales.
IotHubResourceImportDevicesOptionalParams	Parámetros opcionales.
IotHubResourceListByResourceGroupNextOptionalParams	Parámetros opcionales.
IotHubResourceListByResourceGroupOptionalParams	Parámetros opcionales.
IotHubResourceListBySubscriptionNextOptionalParams	Parámetros opcionales.
IotHubResourceListBySubscriptionOptionalParams	Parámetros opcionales.
IotHubResourceListEventHubConsumerGroupsNextOptionalParams	Parámetros opcionales.
IotHubResourceListEventHubConsumerGroupsOptionalParams	Parámetros opcionales.
IotHubResourceListJobsNextOptionalParams	Parámetros opcionales.
IotHubResourceListJobsOptionalParams	Parámetros opcionales.
IotHubResourceListKeysNextOptionalParams	Parámetros opcionales.
IotHubResourceListKeysOptionalParams	Parámetros opcionales.
IotHubResourceTestAllRoutesOptionalParams	Parámetros opcionales.
IotHubResourceTestRouteOptionalParams	Parámetros opcionales.
IotHubResourceUpdateOptionalParams	Parámetros opcionales.
IotHubSkuDescription	Propiedades de SKU.
IotHubSkuDescriptionListResult	Matriz serializada por JSON de objetos IotHubSkuDescription con un vínculo siguiente.
IotHubSkuInfo	Información sobre la SKU del centro de IoT.
IpFilterRule	Las reglas de filtro IP del centro de IoT.
JobResponse	Propiedades del objeto Job Response.
JobResponseListResult	Matriz serializada json de objetos JobResponse con un vínculo siguiente.
ManagedIdentity	Propiedades de la identidad administrada.
MatchedRoute	Rutas que coinciden
MessagingEndpointProperties	Las propiedades de los puntos de conexión de mensajería usados por este centro de IoT.
Name	Nombre del tipo de IoT Hub
NetworkRuleSetIpRule	Regla de IP que se va a aplicar como parte del conjunto de reglas de red
NetworkRuleSetProperties	Propiedades del conjunto de reglas de red de IotHub
Operation	Operación de API REST de IoT Hub
OperationDisplay	Objeto que representa la operación.
OperationInputs	Valores de entrada.
OperationListResult	Resultado de la solicitud para enumerar las operaciones de IoT Hub. Contiene una lista de operaciones y un vínculo de dirección URL para obtener el siguiente conjunto de resultados.
Operations	Interfaz que representa una operación.
OperationsListNextOptionalParams	Parámetros opcionales.
OperationsListOptionalParams	Parámetros opcionales.
PrivateEndpoint	La propiedad de punto de conexión privado de una conexión de punto de conexión privado
PrivateEndpointConnection	Conexión de punto de conexión privado de un IotHub
PrivateEndpointConnectionProperties	Propiedades de una conexión de punto de conexión privado
PrivateEndpointConnections	Interfaz que representa un privateEndpointConnections.
PrivateEndpointConnectionsDeleteHeaders	Define encabezados para PrivateEndpointConnections_delete operación.
PrivateEndpointConnectionsDeleteOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsGetOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsListOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsUpdateOptionalParams	Parámetros opcionales.
PrivateLinkResources	Los recursos de vínculo privado disponibles para un IotHub
PrivateLinkResourcesGetOptionalParams	Parámetros opcionales.
PrivateLinkResourcesListOptionalParams	Parámetros opcionales.
PrivateLinkResourcesOperations	Interfaz que representa un PrivateLinkResourcesOperations.
PrivateLinkServiceConnectionState	Estado actual de una conexión de punto de conexión privado
RegistryStatistics	Estadísticas del registro de identidad.
Resource	Las propiedades comunes de un recurso de Azure.
ResourceProviderCommon	Interfaz que representa un resourceProviderCommon.
ResourceProviderCommonGetSubscriptionQuotaOptionalParams	Parámetros opcionales.
RouteCompilationError	Error de compilación al evaluar la ruta
RouteErrorPosition	Posición en la que se produjo el error de ruta
RouteErrorRange	Intervalo de errores de ruta
RouteProperties	Las propiedades de una regla de enrutamiento que el centro de IoT usa para enrutar los mensajes a los puntos de conexión.
RoutingCosmosDBSqlApiProperties	Propiedades relacionadas con un punto de conexión de contenedor sql de Cosmos DB.
RoutingEndpoints	Las propiedades relacionadas con los puntos de conexión personalizados a los que ioT Hub enruta los mensajes en función de las reglas de enrutamiento. Se permite un máximo de 10 puntos de conexión personalizados en todos los tipos de punto de conexión para centros de pago y solo se permite un punto de conexión personalizado en todos los tipos de puntos de conexión para centros gratuitos.
RoutingEventHubProperties	Propiedades relacionadas con un punto de conexión del centro de eventos.
RoutingMessage	Mensaje de enrutamiento
RoutingProperties	Las propiedades relacionadas con el enrutamiento del centro de IoT. Consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
RoutingServiceBusQueueEndpointProperties	Propiedades relacionadas con los tipos de punto de conexión de cola de Service Bus.
RoutingServiceBusTopicEndpointProperties	Las propiedades relacionadas con los tipos de punto de conexión del tema de Service Bus.
RoutingStorageContainerProperties	Propiedades relacionadas con un punto de conexión de contenedor de almacenamiento.
RoutingTwin	Parámetro de entrada de referencia de gemelo. Se trata de un parámetro opcional.
RoutingTwinProperties
SharedAccessSignatureAuthorizationRule	Las propiedades de una directiva de acceso compartido de IoT Hub.
SharedAccessSignatureAuthorizationRuleListResult	Lista de directivas de acceso compartido con un vínculo siguiente.
StorageEndpointProperties	Las propiedades del punto de conexión de Azure Storage para la carga de archivos.
SystemData	Metadatos relativos a la creación y última modificación del recurso.
TagsResource	Un contenedor que contiene solo las etiquetas de un recurso, lo que permite al usuario actualizar las etiquetas en una instancia de IoT Hub.
TestAllRoutesInput	Entrada para probar todas las rutas
TestAllRoutesResult	Resultado de probar todas las rutas
TestRouteInput	Entrada para la ruta de prueba
TestRouteResult	Resultado de la prueba de una ruta
TestRouteResultDetails	Resultado detallado de la prueba de una ruta
UserSubscriptionQuota	Respuesta de cuota de suscripción de usuario
UserSubscriptionQuotaListResult	Matriz serializada json de respuesta de cuota de suscripción de usuario

Alias de tipos

AccessRights	Define valores para AccessRights.
AuthenticationType	Define valores para AuthenticationType. KnownAuthenticationType se puede usar indistintamente con AuthenticationType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio keyBased identityBased
Capabilities	Define los valores de Capabilities. KnownCapabilities se puede usar indistintamente con Capabilities, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Ninguno DeviceManagement
CertificatesCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
CertificatesGenerateVerificationCodeResponse	Contiene datos de respuesta para la operación generateVerificationCode.
CertificatesGetResponse	Contiene datos de respuesta para la operación get.
CertificatesListByIotHubResponse	Contiene datos de respuesta para la operación listByIotHub.
CertificatesVerifyResponse	Contiene datos de respuesta para la operación de comprobación.
CreatedByType	Define valores para CreatedByType. KnownCreatedByType se puede usar indistintamente con CreatedByType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio de usuario de Application managedIdentity clave
DefaultAction	Define los valores de DefaultAction. KnownDefaultAction se puede usar indistintamente con DefaultAction, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio denegar Permitir
EndpointHealthStatus	Define valores para EndpointHealthStatus. knownEndpointHealthStatus se puede usar indistintamente con EndpointHealthStatus, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio desconocido correctos degradado incorrectos muertos
IotHubNameUnavailabilityReason	Define valores para IotHubNameUnavailabilityReason.
IotHubReplicaRoleType	Define valores para IotHubReplicaRoleType. KnownIotHubReplicaRoleType se puede usar indistintamente con IotHubReplicaRoleType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio principal secundaria
IotHubResourceCheckNameAvailabilityResponse	Contiene datos de respuesta para la operación checkNameAvailability.
IotHubResourceCreateEventHubConsumerGroupResponse	Contiene datos de respuesta para la operación createEventHubConsumerGroup.
IotHubResourceCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
IotHubResourceDeleteResponse	Contiene datos de respuesta para la operación de eliminación.
IotHubResourceExportDevicesResponse	Contiene datos de respuesta para la operación exportDevices.
IotHubResourceGetEndpointHealthNextResponse	Contiene datos de respuesta para la operación getEndpointHealthNext.
IotHubResourceGetEndpointHealthResponse	Contiene datos de respuesta para la operación getEndpointHealth.
IotHubResourceGetEventHubConsumerGroupResponse	Contiene datos de respuesta para la operación getEventHubConsumerGroup.
IotHubResourceGetJobResponse	Contiene datos de respuesta para la operación getJob.
IotHubResourceGetKeysForKeyNameResponse	Contiene datos de respuesta para la operación getKeysForKeyName.
IotHubResourceGetQuotaMetricsNextResponse	Contiene datos de respuesta para la operación getQuotaMetricsNext.
IotHubResourceGetQuotaMetricsResponse	Contiene datos de respuesta para la operación getQuotaMetrics.
IotHubResourceGetResponse	Contiene datos de respuesta para la operación get.
IotHubResourceGetStatsResponse	Contiene datos de respuesta para la operación getStats.
IotHubResourceGetValidSkusNextResponse	Contiene datos de respuesta para la operación getValidSkusNext.
IotHubResourceGetValidSkusResponse	Contiene datos de respuesta para la operación getValidSkus.
IotHubResourceImportDevicesResponse	Contiene datos de respuesta para la operación importDevices.
IotHubResourceListByResourceGroupNextResponse	Contiene datos de respuesta para la operación listByResourceGroupNext.
IotHubResourceListByResourceGroupResponse	Contiene datos de respuesta para la operación listByResourceGroup.
IotHubResourceListBySubscriptionNextResponse	Contiene datos de respuesta para la operación listBySubscriptionNext.
IotHubResourceListBySubscriptionResponse	Contiene datos de respuesta para la operación listBySubscription.
IotHubResourceListEventHubConsumerGroupsNextResponse	Contiene datos de respuesta para la operación listEventHubConsumerGroupsNext.
IotHubResourceListEventHubConsumerGroupsResponse	Contiene datos de respuesta para la operación listEventHubConsumerGroups.
IotHubResourceListJobsNextResponse	Contiene datos de respuesta para la operación listJobsNext.
IotHubResourceListJobsResponse	Contiene datos de respuesta para la operación listJobs.
IotHubResourceListKeysNextResponse	Contiene datos de respuesta para la operación listKeysNext.
IotHubResourceListKeysResponse	Contiene datos de respuesta para la operación listKeys.
IotHubResourceTestAllRoutesResponse	Contiene datos de respuesta para la operación testAllRoutes.
IotHubResourceTestRouteResponse	Contiene datos de respuesta para la operación testRoute.
IotHubResourceUpdateResponse	Contiene datos de respuesta para la operación de actualización.
IotHubScaleType	Define valores para IotHubScaleType.
IotHubSku	Define valores para IotHubSku. KnownIotHubSku se puede usar indistintamente con IotHubSku, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio F1 S1 S2 S3 B1 B2 B3
IotHubSkuTier	Define valores para IotHubSkuTier.
IpFilterActionType	Define valores para IpFilterActionType.
JobStatus	Define valores para JobStatus.
JobType	Define valores para JobType. KnownJobType se puede usar indistintamente con JobType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio desconocido de exportación importar de copia de seguridad readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate
NetworkRuleIPAction	Define valores para NetworkRuleIPAction. KnownNetworkRuleIPAction se puede usar indistintamente con NetworkRuleIPAction, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Permitir
OperationsListNextResponse	Contiene datos de respuesta para la operación listNext.
OperationsListResponse	Contiene datos de respuesta para la operación de lista.
PrivateEndpointConnectionsDeleteResponse	Contiene datos de respuesta para la operación de eliminación.
PrivateEndpointConnectionsGetResponse	Contiene datos de respuesta para la operación get.
PrivateEndpointConnectionsListResponse	Contiene datos de respuesta para la operación de lista.
PrivateEndpointConnectionsUpdateResponse	Contiene datos de respuesta para la operación de actualización.
PrivateLinkResourcesGetResponse	Contiene datos de respuesta para la operación get.
PrivateLinkResourcesListResponse	Contiene datos de respuesta para la operación de lista.
PrivateLinkServiceConnectionStatus	Define valores para PrivateLinkServiceConnectionStatus. knownPrivateLinkServiceConnectionStatus se puede usar indistintamente con PrivateLinkServiceConnectionStatus, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio pendiente aprobados rechazados desconectado
PublicNetworkAccess	Define valores para PublicNetworkAccess. KnownPublicNetworkAccess se puede usar indistintamente con PublicNetworkAccess, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio habilitado para deshabilitado
ResourceIdentityType	Define valores para ResourceIdentityType.
ResourceProviderCommonGetSubscriptionQuotaResponse	Contiene datos de respuesta para la operación getSubscriptionQuota.
RouteErrorSeverity	Define los valores de RouteErrorSeverity. KnownRouteErrorSeverity se puede usar indistintamente con RouteErrorSeverity, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio de error de advertencia
RoutingSource	Define valores para RoutingSource. KnownRoutingSource se puede usar indistintamente con RoutingSource, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio no válidos deviceMessages de twinChangeEvents de DeviceLifecycleEvents DeviceJobLifecycleEvents DeviceConnectionStateEvents
RoutingStorageContainerPropertiesEncoding	Define valores para RoutingStorageContainerPropertiesEncoding. knownRoutingStorageContainerPropertiesEncoding se puede usar indistintamente con RoutingStorageContainerPropertiesEncoding, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Avro AvroDeflate JSON
TestResultStatus	Define valores para TestResultStatus. KnownTestResultStatus se puede usar indistintamente con TestResultStatus, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio sin definir false verdadero

Enumeraciones

KnownAuthenticationType	Valores conocidos de AuthenticationType que acepta el servicio.
KnownCapabilities	Los valores conocidos de Capabilities que acepta el servicio.
KnownCreatedByType	Los valores conocidos de CreatedByType que acepta el servicio.
KnownDefaultAction	Valores conocidos de DefaultAction que acepta el servicio.
KnownEndpointHealthStatus	Los valores conocidos de EndpointHealthStatus que acepta el servicio.
KnownIotHubReplicaRoleType	Valores conocidos de IotHubReplicaRoleType que acepta el servicio.
KnownIotHubSku	Los valores conocidos de IotHubSku que acepta el servicio.
KnownJobType	Los valores conocidos de JobType que acepta el servicio.
KnownNetworkRuleIPAction	Valores conocidos de NetworkRuleIPAction que acepta el servicio.
KnownPrivateLinkServiceConnectionStatus	Los valores conocidos de PrivateLinkServiceConnectionStatus que acepta el servicio.
KnownPublicNetworkAccess	Valores conocidos de PublicNetworkAccess que acepta el servicio.
KnownRouteErrorSeverity	Los valores conocidos de RouteErrorSeverity que acepta el servicio.
KnownRoutingSource	Valores conocidos de RoutingSource que acepta el servicio.
KnownRoutingStorageContainerPropertiesEncoding	Valores conocidos de RoutingStorageContainerPropertiesEncoding que acepta el servicio.
KnownTestResultStatus	Los valores conocidos de TestResultStatus que acepta el servicio.

Funciones

getContinuationToken(unknown)

Dada la última .value generada por el iterador de byPage, devuelve un token de continuación que se puede usar para comenzar la paginación desde ese punto más adelante.

Detalles de la función

getContinuationToken(unknown)

Dada la última .value generada por el iterador de byPage, devuelve un token de continuación que se puede usar para comenzar la paginación desde ese punto más adelante.

function getContinuationToken(page: unknown): string | undefined

Parámetros

page

unknown

Objeto desde el que se accede a value en IteratorResult desde un iterador de byPage.

Devoluciones

string | undefined

Token de continuación que se puede pasar a byPage() durante futuras llamadas.