IotHubResource interface
Interfaccia che rappresenta un oggetto IotHubResource.
Metodi
Dettagli metodo
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Creare o aggiornare i metadati di un hub IoT. Il modello consueto per modificare una proprietà consiste nel recuperare i metadati dell'hub IoT e i metadati di sicurezza e quindi combinarli con i valori modificati in un nuovo corpo per aggiornare l'hub IoT.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
- iotHubDescription
- IotHubDescription
Metadati dell'hub IoT e metadati di sicurezza.
Parametri delle opzioni.
Restituisce
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Creare o aggiornare i metadati di un hub IoT. Il modello consueto per modificare una proprietà consiste nel recuperare i metadati dell'hub IoT e i metadati di sicurezza e quindi combinarli con i valori modificati in un nuovo corpo per aggiornare l'hub IoT.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
- iotHubDescription
- IotHubDescription
Metadati dell'hub IoT e metadati di sicurezza.
Parametri delle opzioni.
Restituisce
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
Eliminare un hub IoT.
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
Parametri delle opzioni.
Restituisce
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
Eliminare un hub IoT.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
Parametri delle opzioni.
Restituisce
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Aggiornare i tag di un hub IoT esistente. per aggiornare altri campi, utilizzare il metodo CreateOrUpdate
function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubResourceUpdateResponse>, IotHubResourceUpdateResponse>>
Parametri
- resourceGroupName
-
string
Identificatore del gruppo di risorse.
- resourceName
-
string
Nome dell'hub IoT da aggiornare.
- iotHubTags
- TagsResource
Aggiornamento delle informazioni sui tag da impostare nell'istanza dell'hub IoT.
Parametri delle opzioni.
Restituisce
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubResourceUpdateResponse>, IotHubResourceUpdateResponse>>
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Aggiornare i tag di un hub IoT esistente. per aggiornare altri campi, utilizzare il metodo CreateOrUpdate
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubResourceUpdateResponse>
Parametri
- resourceGroupName
-
string
Identificatore del gruppo di risorse.
- resourceName
-
string
Nome dell'hub IoT da aggiornare.
- iotHubTags
- TagsResource
Aggiornamento delle informazioni sui tag da impostare nell'istanza dell'hub IoT.
Parametri delle opzioni.
Restituisce
Promise<IotHubResourceUpdateResponse>
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)
Verificare se è disponibile un nome di hub IoT.
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>
Parametri
- operationInputs
- OperationInputs
Impostare il parametro name nella struttura OperationInputs sul nome dell'hub IoT da controllare.
Parametri delle opzioni.
Restituisce
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
Aggiungere un gruppo di consumer a un endpoint compatibile con l'hub eventi in un hub IoT.
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, consumerGroupBody: EventHubConsumerGroupBodyDescription, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
- eventHubEndpointName
-
string
Nome dell'endpoint compatibile con l'hub eventi nell'hub IoT.
- name
-
string
Nome del gruppo di consumer da aggiungere.
- consumerGroupBody
- EventHubConsumerGroupBodyDescription
Gruppo di consumer da aggiungere.
Parametri delle opzioni.
Restituisce
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
Eliminare un gruppo di consumer da un endpoint compatibile con l'hub eventi in un hub IoT.
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
- eventHubEndpointName
-
string
Nome dell'endpoint compatibile con l'hub eventi nell'hub IoT.
- name
-
string
Nome del gruppo di consumer da eliminare.
Parametri delle opzioni.
Restituisce
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
Esporta tutte le identità dei dispositivi nel registro delle identità dell'hub IoT in un contenitore BLOB di Archiviazione di Azure. Per altre informazioni, vedere: 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>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
- exportDevicesParameters
- ExportDevicesRequest
I parametri che specificano l'operazione di esportazione dei dispositivi.
Parametri delle opzioni.
Restituisce
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
Ottenere i metadati non correlati alla sicurezza di un hub IoT.
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
- options
- IotHubResourceGetOptionalParams
Parametri delle opzioni.
Restituisce
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
Ottenere un gruppo di consumer dall'endpoint da dispositivo a cloud compatibile con l'hub eventi per un hub IoT.
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
- eventHubEndpointName
-
string
Nome dell'endpoint compatibile con l'hub eventi nell'hub IoT.
- name
-
string
Nome del gruppo di consumer da recuperare.
Parametri delle opzioni.
Restituisce
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
Ottenere i dettagli di un processo da un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
- jobId
-
string
L'identificatore del processo.
Parametri delle opzioni.
Restituisce
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
Ottenere un criterio di accesso condiviso in base al nome da un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
- keyName
-
string
Nome dei criteri di accesso condiviso.
Parametri delle opzioni.
Restituisce
getStats(string, string, IotHubResourceGetStatsOptionalParams)
Ottenere le statistiche da un hub IoT.
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
Parametri delle opzioni.
Restituisce
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
Importare, aggiornare o eliminare le identità dei dispositivi nel registro delle identità dell'hub IoT da un BLOB. Per altre informazioni, vedere: 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>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
- importDevicesParameters
- ImportDevicesRequest
I parametri che specificano l'operazione di importazione dei dispositivi.
Parametri delle opzioni.
Restituisce
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
Ottenere tutti gli hub IoT in un gruppo di risorse.
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
Parametri delle opzioni.
Restituisce
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
Ottieni tutti gli hub IoT in una sottoscrizione.
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Parametri
Parametri delle opzioni.
Restituisce
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)
Ottenere l'integrità per gli endpoint di routing.
function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>
Parametri
- resourceGroupName
-
string
- iotHubName
-
string
Parametri delle opzioni.
Restituisce
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)
Ottenere un elenco dei gruppi di consumer nell'endpoint da dispositivo a cloud compatibile con l'hub eventi in un hub IoT.
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
- eventHubEndpointName
-
string
Nome dell'endpoint compatibile con l'hub eventi.
Parametri delle opzioni.
Restituisce
listJobs(string, string, IotHubResourceListJobsOptionalParams)
Ottenere un elenco di tutti i processi in un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
Parametri delle opzioni.
Restituisce
listKeys(string, string, IotHubResourceListKeysOptionalParams)
Ottenere i metadati di sicurezza per un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
Parametri delle opzioni.
Restituisce
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
Ottenere le metriche delle quote per un hub IoT.
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
Parametri delle opzioni.
Restituisce
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
Ottenere l'elenco di SKU validi per un hub IoT.
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>
Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'hub IoT.
- resourceName
-
string
Nome dell'hub IoT.
Parametri delle opzioni.
Restituisce
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
Testare tutte le route configurate in questo hub IoT
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>
Parametri
- iotHubName
-
string
IotHub da testare
- resourceGroupName
-
string
gruppo di risorse a cui appartiene l'hub IoT
- input
- TestAllRoutesInput
Input per il test di tutti i percorsi
Parametri delle opzioni.
Restituisce
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
Testare il nuovo percorso per questo hub IoT
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>
Parametri
- iotHubName
-
string
IotHub da testare
- resourceGroupName
-
string
gruppo di risorse a cui appartiene l'hub IoT
- input
- TestRouteInput
Percorso che deve essere testato
Parametri delle opzioni.
Restituisce
Promise<TestRouteResult>