IotHubResource interface
Interfaz que representa un IotHubResource.
Métodos
| begin |
Cree o actualice los metadatos de un centro de IoT. El patrón habitual para modificar una propiedad es recuperar los metadatos de IoT Hub y los metadatos de seguridad y, a continuación, combinarlos con los valores modificados en un nuevo cuerpo para actualizar el centro de IoT. Si faltan determinadas propiedades en el JSON, actualizar IoT Hub puede hacer que estos valores se reversión de forma predeterminada, lo que puede provocar un comportamiento inesperado. |
| begin |
Cree o actualice los metadatos de un centro de IoT. El patrón habitual para modificar una propiedad es recuperar los metadatos de IoT Hub y los metadatos de seguridad y, a continuación, combinarlos con los valores modificados en un nuevo cuerpo para actualizar el centro de IoT. Si faltan determinadas propiedades en el JSON, actualizar IoT Hub puede hacer que estos valores se reversión de forma predeterminada, lo que puede provocar un comportamiento inesperado. |
| begin |
Elimine un centro de IoT. |
| begin |
Elimine un centro de IoT. |
| begin |
Actualice una etiqueta de IoT Hub existente. para actualizar otros campos, use el método CreateOrUpdate. |
| begin |
Actualice una etiqueta de IoT Hub existente. para actualizar otros campos, use el método CreateOrUpdate. |
| check |
Compruebe si hay disponible un nombre de centro de IoT. |
| create |
Agregue un grupo de consumidores a un punto de conexión compatible con Event Hubs en un centro de IoT. |
| delete |
Elimine un grupo de consumidores de un punto de conexión compatible con Event Hubs en un centro de IoT. |
| export |
Exporta todas las identidades de dispositivo del registro de identidades de IoT Hub a un contenedor de blobs de Azure Storage. Para obtener más información, vea: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. |
| get(string, string, Iot |
Obtenga los metadatos no relacionados con la seguridad de un centro de IoT. |
| get |
Obtenga un grupo de consumidores del punto de conexión de dispositivo a nube compatible con Event Hubs para un centro de IoT. |
| get |
Obtenga los detalles de un trabajo de un centro de IoT. Para obtener más información, vea: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. |
| get |
Obtenga una directiva de acceso compartido por su nombre desde un centro de IoT. Para obtener más información, vea: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. |
| get |
Obtenga las estadísticas de un centro de IoT. |
| import |
Importe, actualice o elimine identidades de dispositivo en el registro de identidades de IoT Hub desde un blob. Para obtener más información, vea: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. |
| list |
Obtenga todos los centros de IoT de un grupo de recursos. |
| list |
Obtenga todos los centros de IoT en una suscripción. |
| list |
Obtenga el estado de los puntos de conexión de enrutamiento. |
| list |
Obtenga una lista de los grupos de consumidores en el punto de conexión de dispositivo a nube compatible con Event Hubs en un centro de IoT. |
| list |
Obtenga una lista de todos los trabajos de un centro de IoT. Para obtener más información, vea: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. |
| list |
Obtenga los metadatos de seguridad de un centro de IoT. Para obtener más información, vea: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. |
| list |
Obtenga las métricas de cuota de un centro de IoT. |
| list |
Obtenga la lista de SKU válidas para un centro de IoT. |
| test |
Prueba de todas las rutas configuradas en este centro de IoT |
| test |
Prueba de la nueva ruta para este centro de IoT |
Detalles del método
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Cree o actualice los metadatos de un centro de IoT. El patrón habitual para modificar una propiedad es recuperar los metadatos de IoT Hub y los metadatos de seguridad y, a continuación, combinarlos con los valores modificados en un nuevo cuerpo para actualizar el centro de IoT. Si faltan determinadas propiedades en el JSON, actualizar IoT Hub puede hacer que estos valores se reversión de forma predeterminada, lo que puede provocar un comportamiento inesperado.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
- iotHubDescription
- IotHubDescription
Metadatos de IoT Hub y metadatos de seguridad.
Parámetros de opciones.
Devoluciones
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Cree o actualice los metadatos de un centro de IoT. El patrón habitual para modificar una propiedad es recuperar los metadatos de IoT Hub y los metadatos de seguridad y, a continuación, combinarlos con los valores modificados en un nuevo cuerpo para actualizar el centro de IoT. Si faltan determinadas propiedades en el JSON, actualizar IoT Hub puede hacer que estos valores se reversión de forma predeterminada, lo que puede provocar un comportamiento inesperado.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
- iotHubDescription
- IotHubDescription
Metadatos de IoT Hub y metadatos de seguridad.
Parámetros de opciones.
Devoluciones
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
Elimine un centro de IoT.
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
Parámetros de opciones.
Devoluciones
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
Elimine un centro de IoT.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
Parámetros de opciones.
Devoluciones
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Actualice una etiqueta de IoT Hub existente. para actualizar otros campos, use el método CreateOrUpdate.
function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Parámetros
- resourceGroupName
-
string
Identificador del grupo de recursos.
- resourceName
-
string
Nombre del centro de iot que se va a actualizar.
- iotHubTags
- TagsResource
Se ha actualizado la información de etiqueta que se va a establecer en la instancia de IoT Hub.
Parámetros de opciones.
Devoluciones
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Actualice una etiqueta de IoT Hub existente. para actualizar otros campos, use el método CreateOrUpdate.
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>
Parámetros
- resourceGroupName
-
string
Identificador del grupo de recursos.
- resourceName
-
string
Nombre del centro de iot que se va a actualizar.
- iotHubTags
- TagsResource
Se ha actualizado la información de etiqueta que se va a establecer en la instancia de IoT Hub.
Parámetros de opciones.
Devoluciones
Promise<IotHubDescription>
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)
Compruebe si hay disponible un nombre de centro de IoT.
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>
Parámetros
- operationInputs
- OperationInputs
Establezca el parámetro name en la estructura OperationInputs en el nombre del centro de IoT que se va a comprobar.
Parámetros de opciones.
Devoluciones
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
Agregue un grupo de consumidores a un punto de conexión compatible con Event Hubs en un centro de IoT.
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, consumerGroupBody: EventHubConsumerGroupBodyDescription, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
- eventHubEndpointName
-
string
Nombre del punto de conexión compatible con Event Hubs en el centro de IoT.
- name
-
string
Nombre del grupo de consumidores que se va a agregar.
- consumerGroupBody
- EventHubConsumerGroupBodyDescription
Grupo de consumidores que se va a agregar.
Parámetros de opciones.
Devoluciones
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
Elimine un grupo de consumidores de un punto de conexión compatible con Event Hubs en un centro de IoT.
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
- eventHubEndpointName
-
string
Nombre del punto de conexión compatible con Event Hubs en el centro de IoT.
- name
-
string
Nombre del grupo de consumidores que se va a eliminar.
Parámetros de opciones.
Devoluciones
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
Exporta todas las identidades de dispositivo del registro de identidades de IoT Hub a un contenedor de blobs de Azure Storage. Para obtener más información, vea: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
function exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: ExportDevicesRequest, options?: IotHubResourceExportDevicesOptionalParams): Promise<JobResponse>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
- exportDevicesParameters
- ExportDevicesRequest
Parámetros que especifican la operación de exportación de dispositivos.
Parámetros de opciones.
Devoluciones
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
Obtenga los metadatos no relacionados con la seguridad de un centro de IoT.
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
- options
- IotHubResourceGetOptionalParams
Parámetros de opciones.
Devoluciones
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
Obtenga un grupo de consumidores del punto de conexión de dispositivo a nube compatible con Event Hubs para un centro de IoT.
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
- eventHubEndpointName
-
string
Nombre del punto de conexión compatible con Event Hubs en el centro de IoT.
- name
-
string
Nombre del grupo de consumidores que se va a recuperar.
Parámetros de opciones.
Devoluciones
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
Obtenga los detalles de un trabajo de un centro de IoT. Para obtener más información, vea: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
- jobId
-
string
Identificador del trabajo.
Parámetros de opciones.
Devoluciones
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
Obtenga una directiva de acceso compartido por su nombre desde un centro de IoT. Para obtener más información, vea: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
- keyName
-
string
Nombre de la directiva de acceso compartido.
Parámetros de opciones.
Devoluciones
getStats(string, string, IotHubResourceGetStatsOptionalParams)
Obtenga las estadísticas de un centro de IoT.
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
Parámetros de opciones.
Devoluciones
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
Importe, actualice o elimine identidades de dispositivo en el registro de identidades de IoT Hub desde un blob. Para obtener más información, vea: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
function importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: ImportDevicesRequest, options?: IotHubResourceImportDevicesOptionalParams): Promise<JobResponse>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
- importDevicesParameters
- ImportDevicesRequest
Parámetros que especifican la operación de importación de dispositivos.
Parámetros de opciones.
Devoluciones
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
Obtenga todos los centros de IoT de un grupo de recursos.
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
Parámetros de opciones.
Devoluciones
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
Obtenga todos los centros de IoT en una suscripción.
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Parámetros
Parámetros de opciones.
Devoluciones
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)
Obtenga el estado de los puntos de conexión de enrutamiento.
function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>
Parámetros
- resourceGroupName
-
string
- iotHubName
-
string
Parámetros de opciones.
Devoluciones
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)
Obtenga una lista de los grupos de consumidores en el punto de conexión de dispositivo a nube compatible con Event Hubs en un centro de IoT.
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
- eventHubEndpointName
-
string
Nombre del punto de conexión compatible con Event Hubs.
Parámetros de opciones.
Devoluciones
listJobs(string, string, IotHubResourceListJobsOptionalParams)
Obtenga una lista de todos los trabajos de un centro de IoT. Para obtener más información, vea: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
Parámetros de opciones.
Devoluciones
listKeys(string, string, IotHubResourceListKeysOptionalParams)
Obtenga los metadatos de seguridad de un centro de IoT. Para obtener más información, vea: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
Parámetros de opciones.
Devoluciones
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
Obtenga las métricas de cuota de un centro de IoT.
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
Parámetros de opciones.
Devoluciones
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
Obtenga la lista de SKU válidas para un centro de IoT.
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el centro de IoT.
- resourceName
-
string
Nombre del centro de IoT.
Parámetros de opciones.
Devoluciones
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
Prueba de todas las rutas configuradas en este centro de IoT
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>
Parámetros
- iotHubName
-
string
IotHub que se va a probar
- resourceGroupName
-
string
grupo de recursos al que pertenece IoT Hub
- input
- TestAllRoutesInput
Entrada para probar todas las rutas
Parámetros de opciones.
Devoluciones
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
Prueba de la nueva ruta para este centro de IoT
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>
Parámetros
- iotHubName
-
string
IotHub que se va a probar
- resourceGroupName
-
string
grupo de recursos al que pertenece IoT Hub
- input
- TestRouteInput
Ruta que debe probarse
Parámetros de opciones.
Devoluciones
Promise<TestRouteResult>