Condividi tramite

Azure IoT Central V3 (anteprima)

Azure IoT Central semplifica la connessione, il monitoraggio e la gestione dei dispositivi IoT su larga scala. Con il connettore IoT Central V3 è possibile attivare i flussi di lavoro quando una regola è stata attivata ed eseguire azioni eseguendo comandi, aggiornando le proprietà, ottenendo dati di telemetria dai dispositivi e altro ancora. Usare questo connettore con l'applicazione Azure IoT Central V3.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio Class Regions
Copilot Studio Di alta qualità Tutte le aree di Power Automate , ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica Normale Tutte le aree di App per la logica , ad eccezione delle seguenti:
     - Aree di Azure per enti pubblici
     - Aree di Azure Cina
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps Di alta qualità Tutte le aree di Power Apps , ad eccezione dei seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate Di alta qualità Tutte le aree di Power Automate , ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Contatto
Nome Supporto tecnico di Azure IoT Central
URL https://aka.ms/iotcentral-create-technical-support-ticket-trial
Metadati del connettore
Editore Microsoft Corporation
Sito web https://azure.microsoft.com/services/iot-central/
Informativa sulla privacy https://privacy.microsoft.com
Categorie Internet delle cose

Il connettore Azure IoT Central V3 può essere usato per connettere l'applicazione Azure IoT Central V3 ai flussi di lavoro. È possibile usare il connettore per eseguire flussi di lavoro quando viene attivata una regola. È possibile usarla per ottenere le informazioni più recenti dai dispositivi IoT, ad esempio dati di telemetria e proprietà. È anche possibile usarlo per aggiornare i dispositivi IoT inviando comandi e aggiornando i appropriateite.

Prerequisiti

  • Per usare questo connettore, è necessario essere un utente in un'applicazione Azure IoT Central V3 con pagamento in base al consumoYou-Go.
  • È necessario utilizzare un account aziendale o dell'istituto di istruzione Microsoft Entra ID.

Come ottenere le credenziali

Per aggiungere questo connettore al flusso di lavoro, è prima necessario accedere all'account aziendale o dell'istituto di istruzione Microsoft Entra ID che è un utente dell'applicazione Azure IoT Central a cui si vuole connettersi.

Note di rilascio

Settembre 2021

  • Il connettore Azure IoT Central V3 è stato aggiornato per allinearsi alla superficie dell'API REST disponibile a livello generale. Tutte le azioni del connettore ora supportano il formato DTDLv2 e il supporto per i modelli basati su DTDLv1 sono deprecati.
  • Le azioni in Run a device command, Get/Update device propertiese Get device telemetry value sono state aggiornate per aggiungere il supporto alle funzionalità più recenti del modello di dispositivo in Azure IoT Central. Queste azioni ora supportano funzionalità radice e componente.
  • È stato aggiunto un nuovo set di azioni del modulo dispositivo. Queste azioni consentono la creazione di flussi di lavoro che interagiscono con comandi, proprietà, telemetrie di moduli e componenti del modulo.
  • Azioni da aggiornare per allinearsi Get/Create/Update/Delete a device alla versione più recente dell'API REST di Azure IoT Central.
  • Le azioni Get device cloud properties e Update device cloud properties ora fanno parte di Get device properties e Update device properties. Le nuove azioni consentono ai flussi di lavoro di interagire contemporaneamente con le proprietà del dispositivo e le proprietà cloud.

Avviso di deprecazione: entro la fine di CY21, le azioni contrassegnate come deprecate nell'elenco seguente non saranno più disponibili durante la creazione di nuovi flussi di lavoro. I flussi di lavoro esistenti che fanno riferimento a queste azioni continueranno a funzionare fino a marzo 2022. È consigliabile aggiornare i flussi di lavoro per sfruttare le azioni appena annunciate ora supportate in Azure IoT Central.

Novembre 2021

  • Sono state aggiunte nuove azioni per elencare i dispositivi e i modelli di dispositivo per un'applicazione Azure IoT Central. Queste azioni includono il supporto della paginazione.
  • È stato aggiunto un nuovo set di azioni di gestione degli utenti al connettore, consentendo ai flussi di lavoro di creare, aggiornare, elencare ed eliminare utenti di un'applicazione.
  • I flussi di lavoro possono ora ottenere l'esecuzione più recente di un comando del dispositivo usando le nuove Get device command response azioni. Questo set di azioni supporta i comandi radice, componente e modulo.

Problemi noti e limitazioni

  • Per usare questo connettore in Microsoft Power Automate, è necessario aver eseguito l'accesso all'applicazione IoT Central almeno una volta. In caso contrario, l'applicazione non verrà visualizzata nell'elenco a discesa Applicazione
  • Gli account personali Microsoft ,ad esempio @hotmail.com, @live.com, , non @outlook.com sono supportati per accedere al connettore IoT Central. È necessario utilizzare un account aziendale o dell'istituto di istruzione Microsoft Entra ID.

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:
Credentials Credentials Tutte le aree geografiche Non condivisibile
Impostazione predefinita [DEPRECATO] Questa opzione è solo per le connessioni meno recenti senza un tipo di autenticazione esplicito e viene fornita solo per la compatibilità con le versioni precedenti. Tutte le aree geografiche Non condivisibile

Credentials

ID autenticazione: 1stparty

Applicabile: tutte le aree

Credentials

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Impostazione predefinita [DEPRECATO]

Applicabile: tutte le aree

Questa opzione è solo per le connessioni meno recenti senza un tipo di autenticazione esplicito e viene fornita solo per la compatibilità con le versioni precedenti.

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Limiti per la limitazione delle richieste

Nome Chiamate Periodo di rinnovo
Chiamate API per connessione 100 60 secondi

Azioni

Aggiornare le proprietà cloud del dispositivo (deprecato)

Aggiornare tutti i valori delle proprietà cloud di un dispositivo in base all'ID dispositivo (deprecato).
Aggiornare le proprietà del dispositivo

Aggiornare tutti i valori delle proprietà di un dispositivo in base all'ID dispositivo.
Aggiornare le proprietà del dispositivo (deprecato)

Aggiornare tutti i valori delle proprietà di un dispositivo in base all'ID dispositivo (deprecato).
Aggiornare le proprietà del modulo

Aggiornare tutti i valori delle proprietà di un modulo.
Aggiornare un processo pianificato

Aggiornare un processo pianificato esistente in base all'ID.
Aggiornare un utente

Aggiornare un utente nell'applicazione tramite patch
Aggiornare una relazione tra dispositivi

Aggiornare una relazione di dispositivo esistente tra il dispositivo specificato e un nuovo dispositivo in base a un ID dispositivo e a un ID relazione.
Arrestare un processo in esecuzione

Arrestare l'esecuzione di un processo attualmente in esecuzione.
Crea un lavoro

Creare ed eseguire un nuovo processo tramite la relativa definizione di processo.
Creare o aggiornare un dispositivo

Creare un nuovo dispositivo o aggiornare un dispositivo esistente in base all'ID dispositivo.
Creare o aggiornare un dispositivo (deprecato)

Creare un nuovo dispositivo o aggiornare un dispositivo esistente in base all'ID dispositivo. (deprecato)
Creare o aggiornare un dispositivo (deprecato)

Creare un nuovo dispositivo o aggiornare un dispositivo esistente in base all'ID dispositivo (deprecato).
Creare un'organizzazione

Creare una nuova organizzazione.
Creare un gruppo di dispositivi

Creare o aggiornare un gruppo di dispositivi.
Creare un processo pianificato

Creare ed eseguire un nuovo processo pianificato tramite la relativa definizione di processo.
Creare un utente

Creare un utente nell'applicazione
Creare una relazione tra dispositivi

Creare una nuova relazione di dispositivo tra il dispositivo specificato e un nuovo dispositivo in base a un ID dispositivo e a un ID relazione.
Elencare gli utenti

Ottenere l'elenco di utenti in un'applicazione
Elencare i dispositivi

Ottenere l'elenco dei dispositivi in un'applicazione.
Elencare i gruppi di dispositivi

Ottenere l'elenco dei gruppi di dispositivi in un'applicazione.
Elencare i modelli di dispositivo

Ottenere l'elenco dei modelli di dispositivo in un'applicazione.
Elencare i processi

Ottenere l'elenco dei processi in un'applicazione.
Elencare i processi pianificati

Ottenere l'elenco dei processi pianificati in un'applicazione.
Elencare i ruoli

Ottenere l'elenco dei ruoli in un'applicazione.
Elencare le organizzazioni

Ottenere l'elenco delle organizzazioni in un'applicazione.
Elencare le relazioni

Elencare tutte le relazioni in base all'ID dispositivo.
Eliminare l'organizzazione

Eliminare un'organizzazione esistente in base all'ID
Eliminare l'utente

Eliminare un utente
Eliminare un dispositivo

Eliminare un dispositivo esistente in base all'ID dispositivo.
Eliminare un dispositivo (deprecato)

Eliminare un dispositivo esistente in base all'ID dispositivo (deprecato).
Eliminare un gruppo di dispositivi

Eliminare un gruppo di dispositivi esistente in base all'ID
Eliminare un modello di dispositivo

Eliminare un modello di dispositivo esistente in base all'ID.
Eliminare un processo pianificato

Eliminare un processo pianificato esistente in base all'ID.
Eliminare una relazione tra dispositivi

Eliminare una relazione di dispositivo esistente in base all'ID dispositivo e all'ID relazione.
Eseguire un comando componente

Eseguire un comando in un componente.
Eseguire un comando del componente del modulo

Eseguire un comando in un componente del modulo.
Eseguire un comando del dispositivo

Eseguire un comando in un dispositivo.
Eseguire un comando del dispositivo (deprecato)

Eseguire un comando in un dispositivo (deprecato).
Eseguire un comando del modulo

Eseguire un comando in un modulo.
Ottenere gli stati del dispositivo

Ottenere l'elenco dei singoli stati del dispositivo in base all'ID processo.
Ottenere i dispositivi in base all'ID gruppo di dispositivi

Ottenere l'elenco dei dispositivi in un gruppo di dispositivi in un'applicazione.
Ottenere il ruolo

Ottenere un ruolo in base all'ID.
Ottenere il valore di telemetria del componente

Ottenere l'ultimo valore di telemetria da un componente.
Ottenere il valore di telemetria del componente del modulo

Ottenere l'ultimo valore di telemetria da un componente del modulo.
Ottenere il valore di telemetria del dispositivo

Ottenere l'ultimo valore di telemetria da un dispositivo.
Ottenere il valore di telemetria del dispositivo (deprecato)

Ottenere l'ultimo valore di telemetria da un dispositivo (deprecato).
Ottenere il valore di telemetria del modulo

Ottenere l'ultimo valore di telemetria da un modulo.
Ottenere l'utente

Ottenere un utente in base all'ID
Ottenere la risposta al comando del componente

Ottenere l'ultima risposta per un comando del componente del dispositivo.
Ottenere la risposta del comando del componente del modulo

Ottenere l'ultima risposta per un comando del componente del modulo.
Ottenere la risposta del comando del dispositivo

Ottenere l'ultima risposta per un comando del dispositivo.
Ottenere la risposta del comando del modulo

Ottenere l'ultima risposta per un comando del modulo del dispositivo
Ottenere le proprietà cloud del dispositivo (obsoleto)

Ottenere tutti i valori delle proprietà cloud di un dispositivo in base all'ID dispositivo (deprecato).
Ottenere le proprietà del dispositivo

Ottenere tutti i valori delle proprietà di un dispositivo in base all'ID dispositivo.
Ottenere le proprietà del dispositivo (deprecato)

Ottenere tutti i valori delle proprietà di un dispositivo in base all'ID dispositivo (deprecato).
Ottenere le proprietà del modulo

Ottenere tutti i valori delle proprietà di un modulo.
Ottenere processi in base all'ID processo pianificato

Ottenere l'elenco dei processi per una definizione di processo pianificata.
Ottenere un'organizzazione

Ottenere informazioni dettagliate su un'organizzazione esistente in base all'ID.
Ottenere un dispositivo in base all'ID (deprecato)

Ottenere informazioni dettagliate su un dispositivo esistente in base all'ID dispositivo (deprecato).
Ottenere un gruppo di dispositivi

Ottenere informazioni dettagliate su un gruppo di dispositivi esistente in base all'ID.
Ottenere un modello di dispositivo in base all'ID

Ottenere informazioni dettagliate su un modello di dispositivo esistente in base all'ID.
Ottenere un processo

Ottenere informazioni dettagliate su un processo esistente in base all'ID.
Ottenere un processo pianificato

Ottenere informazioni dettagliate su un processo pianificato esistente in base all'ID.
Ottenere una relazione tra dispositivi

Ottenere informazioni dettagliate su una relazione di dispositivo esistente in base all'ID dispositivo e all'ID relazione.
Ottieni un dispositivo per ID

Ottenere informazioni dettagliate su un dispositivo esistente in base all'ID dispositivo.
Riprendere un processo arrestato

Riprendere l'esecuzione di un processo arrestato esistente.
Riprendere un processo nei dispositivi non riusciti

Eseguire una riesecuzione di un processo esistente in tutti i dispositivi non riusciti.

Aggiornare le proprietà cloud del dispositivo (deprecato)

ID operazione:
Devices_UpdateCloudProperties

Aggiornare tutti i valori delle proprietà cloud di un dispositivo in base all'ID dispositivo (deprecato).

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
ID modello di dispositivo
 instanceOf string

Definizione del modello di dispositivo per il dispositivo.
body
 body True dynamic

Proprietà del dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Aggiornare le proprietà del dispositivo

ID operazione:
Devices_UpdateProperties_V1

Aggiornare tutti i valori delle proprietà di un dispositivo in base all'ID dispositivo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.
body
 body True dynamic

Proprietà del dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Aggiornare le proprietà del dispositivo (deprecato)

ID operazione:
Devices_UpdateProperties

Aggiornare tutti i valori delle proprietà di un dispositivo in base all'ID dispositivo (deprecato).

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
ID modello di dispositivo
 instanceOf string

Definizione del modello di dispositivo per il dispositivo.
body
 body True dynamic

Proprietà del dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Aggiornare le proprietà del modulo

ID operazione:
Devices_UpdateModuleProperties_V1

Aggiornare tutti i valori delle proprietà di un modulo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Modulo dispositivo
 module True string

Nome del modulo del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.
body
 body True dynamic

Proprietà del dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Aggiornare un processo pianificato

ID operazione:
ScheduledJobs_Update

Aggiornare un processo pianificato esistente in base all'ID.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID processo pianificato
 scheduled_job_id True string

ID univoco del processo pianificato.
Tipo fine pianificazione
 scheduled_job_end_type string

Fine del processo pianificato (non applicato alle migrazioni dei modelli di dispositivo).
Corpo
 body True dynamic

Corpo di creazione processo pianificato.

Restituisce

Definizione del processo pianificato.

Corpo
ScheduledJobStatic

Aggiornare un utente

ID operazione:
Users_Update_V1

Aggiornare un utente nell'applicazione tramite patch

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
User
 user_id True string

ID univoco dell'utente.
Tipo utente
 user_type string

Tipo di utente.
Corpo
 body True dynamic

Corpo dell'aggiornamento dell'utente.

Restituisce

Gli output di questa operazione sono dinamici.

Aggiornare una relazione tra dispositivi

ID operazione:
DeviceRelationships_Update

Aggiornare una relazione di dispositivo esistente tra il dispositivo specificato e un nuovo dispositivo in base a un ID dispositivo e a un ID relazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
ID relazione
 relationship_id True string

ID univoco della relazione del dispositivo.
ID relazione dispositivo
 id string

ID univoco della relazione del dispositivo.
ID destinazione relazione dispositivo
 target True string

ID dispositivo del dispositivo di origine (figlio).

Restituisce

Corpo
DeviceRelationshipStatic

Arrestare un processo in esecuzione

ID operazione:
Jobs_Stop

Arrestare l'esecuzione di un processo attualmente in esecuzione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID lavoro
 job_id True string

ID univoco del processo.

Crea un lavoro

ID operazione:
Jobs_Set

Creare ed eseguire un nuovo processo tramite la relativa definizione di processo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID lavoro
 job_id True string

ID univoco del processo.
Tipo di mansione
 job_type string

Tipo del processo.
Corpo
 body True dynamic

Corpo di creazione del processo.

Restituisce

Gli output di questa operazione sono dinamici.

Creare o aggiornare un dispositivo

ID operazione:
Devices_Set_V2

Creare un nuovo dispositivo o aggiornare un dispositivo esistente in base all'ID dispositivo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
ID del dispositivo
 id string

ID univoco del dispositivo.
Nome dispositivo
 displayName string

Nome visualizzato del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.
Simulato
 simulated boolean

Indica se il dispositivo è simulato.
Enabled
 enabled boolean

Indica se la connessione del dispositivo a IoT Central è stata abilitata.
Organizations
 organizations array of string

L'elenco delle organizzazioni del dispositivo, attualmente è supportata solo un'organizzazione, più organizzazioni saranno presto supportate.
Sottoposto a provisioning
 provisioned boolean

Indica se le risorse sono state allocate per il dispositivo.

Restituisce

Corpo
DeviceV2

Creare o aggiornare un dispositivo (deprecato)

ID operazione:
Devices_Set_V1

Creare un nuovo dispositivo o aggiornare un dispositivo esistente in base all'ID dispositivo. (deprecato)

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
ID del dispositivo
 id string

ID univoco del dispositivo.
Nome dispositivo
 displayName string

Nome visualizzato del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.
Simulato
 simulated boolean

Indica se il dispositivo è simulato.
Enabled
 enabled boolean

Indica se la connessione del dispositivo a IoT Central è stata abilitata.
Sottoposto a provisioning
 provisioned boolean

Indica se le risorse sono state allocate per il dispositivo.

Restituisce

Corpo
DeviceV1

Creare o aggiornare un dispositivo (deprecato)

ID operazione:
Devices_Set

Creare un nuovo dispositivo o aggiornare un dispositivo esistente in base all'ID dispositivo (deprecato).

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
ID del dispositivo
 id string

ID univoco del dispositivo.
Nome dispositivo
 displayName string

Nome visualizzato del dispositivo.
Modello di dispositivo
 instanceOf string

Definizione del modello di dispositivo per il dispositivo.
Simulato
 simulated boolean

Indica se il dispositivo è simulato.
Approvato
 approved boolean

Indica se il dispositivo è stato approvato per la connessione a IoT Central.
Sottoposto a provisioning
 provisioned boolean

Indica se le risorse sono state allocate per il dispositivo.

Restituisce

Corpo
Device

Creare un'organizzazione

ID operazione:
Organizations_Set

Creare una nuova organizzazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID organizzazione
 organization_id True string

ID univoco dell'organizzazione.
ID organizzazione
 id string

ID univoco dell'organizzazione.
Nome organizzazione
 displayName string

Nome visualizzato dell'organizzazione.
Parent
 parent string

Nome visualizzato dell'organizzazione padre.

Restituisce

Corpo
Organization

Creare un gruppo di dispositivi

ID operazione:
DeviceGroups_Set

Creare o aggiornare un gruppo di dispositivi.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID gruppo di dispositivi
 device_group_id True string

ID univoco del gruppo di dispositivi.
ID gruppo di dispositivi
 id string

ID univoco del gruppo di dispositivi.
Nome visualizzato
 displayName True string

Nome visualizzato del gruppo di dispositivi.
Filter
 filter True string

Query che definisce quali dispositivi devono trovarsi in questo gruppo.
Description
 description string

Breve riepilogo del gruppo di dispositivi.
ETag
 etag string

ETag usato per evitare conflitti negli aggiornamenti del gruppo di dispositivi.
Organizations
 organizations array of string

Elenco di organizzazioni del gruppo di dispositivi, attualmente supportata solo un'organizzazione, più organizzazioni saranno presto supportate.

Restituisce

Definizione del gruppo di dispositivi.

Corpo
DeviceGroup

Creare un processo pianificato

ID operazione:
ScheduledJobs_Set

Creare ed eseguire un nuovo processo pianificato tramite la relativa definizione di processo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID processo pianificato
 scheduled_job_id True string

ID univoco del processo pianificato.
Tipo di mansione
 job_type string

Tipo del processo.
Tipo fine pianificazione
 scheduled_job_end_type string

Fine del processo pianificato (non applicato alle migrazioni dei modelli di dispositivo).
Corpo
 body True dynamic

Corpo di creazione processo pianificato.

Restituisce

Gli output di questa operazione sono dinamici.

Creare un utente

ID operazione:
Users_Create_V1

Creare un utente nell'applicazione

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
User
 user_id True string

ID univoco dell'utente.
Tipo utente
 user_type string

Tipo di utente.
Corpo
 body True dynamic

Corpo creato dall'utente.

Restituisce

Gli output di questa operazione sono dinamici.

Creare una relazione tra dispositivi

ID operazione:
DeviceRelationships_Set

Creare una nuova relazione di dispositivo tra il dispositivo specificato e un nuovo dispositivo in base a un ID dispositivo e a un ID relazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID relazione
 relationship_id True string

ID univoco della relazione del dispositivo.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
ID relazione dispositivo
 id string

ID univoco della relazione del dispositivo.
ID destinazione relazione dispositivo
 target True string

ID dispositivo del dispositivo di origine (figlio).

Restituisce

Corpo
DeviceRelationshipStatic

Elencare gli utenti

ID operazione:
Users_List_V1

Ottenere l'elenco di utenti in un'applicazione

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.

Restituisce

Corpo
UserCollectionV1

Elencare i dispositivi

ID operazione:
Devices_List_V1

Ottenere l'elenco dei dispositivi in un'applicazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.

Restituisce

Corpo
DeviceCollectionV1

Elencare i gruppi di dispositivi

ID operazione:
DeviceGroups_List

Ottenere l'elenco dei gruppi di dispositivi in un'applicazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.

Restituisce

Risultati di paging dei gruppi di dispositivi.

Corpo
DeviceGroupCollection

Elencare i modelli di dispositivo

ID operazione:
DeviceTemplates_List_V1

Ottenere l'elenco dei modelli di dispositivo in un'applicazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.

Restituisce

Corpo
DeviceTemplateCollectionV1

Elencare i processi

ID operazione:
Jobs_List

Ottenere l'elenco dei processi in un'applicazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.

Restituisce

Risultati di paging dei processi.

Corpo
JobCollection

Elencare i processi pianificati

ID operazione:
ScheduledJobs_List

Ottenere l'elenco dei processi pianificati in un'applicazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.

Restituisce

Gli output di questa operazione sono dinamici.

Elencare i ruoli

ID operazione:
Roles_List_V1

Ottenere l'elenco dei ruoli in un'applicazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.

Restituisce

Corpo
RoleCollectionV1

Elencare le organizzazioni

ID operazione:
Organizations_List

Ottenere l'elenco delle organizzazioni in un'applicazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.

Restituisce

Corpo
OrganizationCollection

Elencare le relazioni

ID operazione:
DeviceRelationships_List

Elencare tutte le relazioni in base all'ID dispositivo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.

Restituisce

Corpo
DeviceRelationshipCollection

Eliminare l'organizzazione

ID operazione:
Organizations_Remove

Eliminare un'organizzazione esistente in base all'ID

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID organizzazione
 organization_id True string

ID univoco dell'organizzazione.

Eliminare l'utente

ID operazione:
Users_Remove_V1

Eliminare un utente

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
User
 user_id True string

ID univoco dell'utente.

Eliminare un dispositivo

ID operazione:
Devices_Remove_V1

Eliminare un dispositivo esistente in base all'ID dispositivo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.

Eliminare un dispositivo (deprecato)

ID operazione:
Devices_Remove

Eliminare un dispositivo esistente in base all'ID dispositivo (deprecato).

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.

Eliminare un gruppo di dispositivi

ID operazione:
DeviceGroups_Remove

Eliminare un gruppo di dispositivi esistente in base all'ID

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID gruppo di dispositivi
 device_group_id True string

ID univoco del gruppo di dispositivi.

Eliminare un modello di dispositivo

ID operazione:
DeviceTemplates_Remove_V1

Eliminare un modello di dispositivo esistente in base all'ID.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
Template
 template_id True string

ID univoco del modello.

Eliminare un processo pianificato

ID operazione:
ScheduledJobs_Remove

Eliminare un processo pianificato esistente in base all'ID.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID processo pianificato
 scheduled_job_id True string

ID univoco del processo pianificato.

Eliminare una relazione tra dispositivi

ID operazione:
DeviceRelationships_Remove

Eliminare una relazione di dispositivo esistente in base all'ID dispositivo e all'ID relazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
ID relazione
 relationship_id True string

ID univoco della relazione del dispositivo.

Eseguire un comando componente

ID operazione:
Devices_RunComponentCommand_V1

Eseguire un comando in un componente.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Componente del dispositivo
 component_name True string

Nome del componente del dispositivo.
Comando dispositivo
 command_name True string

Nome del comando del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.
body
 body True dynamic

Corpo del comando del dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Eseguire un comando del componente del modulo

ID operazione:
Devices_RunModuleComponentCommand_V1

Eseguire un comando in un componente del modulo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Modulo dispositivo
 module True string

Nome del modulo del dispositivo.
Componente del dispositivo
 component_name True string

Nome del componente del dispositivo.
Comando dispositivo
 command_name True string

Nome del comando del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.
body
 body True dynamic

Corpo del comando del dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Eseguire un comando del dispositivo

ID operazione:
Devices_RunCommand_V1

Eseguire un comando in un dispositivo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Comando dispositivo
 command_name True string

Nome del comando del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.
body
 body True dynamic

Corpo del comando del dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Eseguire un comando del dispositivo (deprecato)

ID operazione:
Devices_ExecuteComponentCommand

Eseguire un comando in un dispositivo (deprecato).

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Componente del dispositivo
 component_name True string

Nome del componente del dispositivo.
Comando dispositivo
 command_name True string

Nome del comando del dispositivo.
ID modello di dispositivo
 instanceOf string

Definizione del modello di dispositivo per il dispositivo.
body
 body True dynamic

Corpo del comando del dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Eseguire un comando del modulo

ID operazione:
Devices_RunModuleCommand_V1

Eseguire un comando in un modulo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Modulo dispositivo
 module True string

Nome del modulo del dispositivo.
Comando dispositivo
 command_name True string

Nome del comando del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.
body
 body True dynamic

Corpo del comando del dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere gli stati del dispositivo

ID operazione:
Jobs_GetDevices

Ottenere l'elenco dei singoli stati del dispositivo in base all'ID processo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID lavoro
 job_id True string

ID univoco del processo.

Restituisce

Risultati di paging degli stati del dispositivo del processo.

Corpo
JobDeviceStatusCollection

Ottenere i dispositivi in base all'ID gruppo di dispositivi

ID operazione:
DeviceGroups_GetDevices

Ottenere l'elenco dei dispositivi in un gruppo di dispositivi in un'applicazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID gruppo di dispositivi
 device_group_id True string

ID univoco del gruppo di dispositivi.

Restituisce

Risultati di paging dei dispositivi appartenenti al gruppo di dispositivi.

Corpo
DeviceGroupDeviceCollection

Ottenere il ruolo

ID operazione:
Roles_Get_V1

Ottenere un ruolo in base all'ID.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
Ruolo
 role_id True string

ID univoco per il ruolo.

Restituisce

Corpo
RoleV1

Ottenere il valore di telemetria del componente

ID operazione:
Devices_GetComponentTelemetryValue_V1

Ottenere l'ultimo valore di telemetria da un componente.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Componente del dispositivo
 component_name True string

Nome del componente del dispositivo.
Telemetria del dispositivo
 telemetry_name True string

Nome dei dati di telemetria del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere il valore di telemetria del componente del modulo

ID operazione:
Devices_GetModuleComponentTelemetryValue_V1

Ottenere l'ultimo valore di telemetria da un componente del modulo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Modulo dispositivo
 module True string

Nome del modulo del dispositivo.
Componente del dispositivo
 component_name True string

Nome del componente del dispositivo.
Telemetria del dispositivo
 telemetry_name True string

Nome dei dati di telemetria del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere il valore di telemetria del dispositivo

ID operazione:
Devices_GetTelemetryValue_V1

Ottenere l'ultimo valore di telemetria da un dispositivo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Telemetria del dispositivo
 telemetry_name True string

Nome dei dati di telemetria del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere il valore di telemetria del dispositivo (deprecato)

ID operazione:
Devices_GetComponentTelemetryValue

Ottenere l'ultimo valore di telemetria da un dispositivo (deprecato).

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Componente del dispositivo
 component_name True string

Nome del componente del dispositivo.
Telemetria del dispositivo
 telemetry_name True string

Nome dei dati di telemetria del dispositivo.
ID modello di dispositivo
 instanceOf string

Definizione del modello di dispositivo per il dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere il valore di telemetria del modulo

ID operazione:
Devices_GetModuleTelemetryValue_V1

Ottenere l'ultimo valore di telemetria da un modulo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Modulo dispositivo
 module True string

Nome del modulo del dispositivo.
Telemetria del dispositivo
 telemetry_name True string

Nome dei dati di telemetria del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere l'utente

ID operazione:
Users_Get_V1

Ottenere un utente in base all'ID

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
User
 user_id True string

ID univoco dell'utente.

Restituisce

Corpo
UserStaticV1

Ottenere la risposta al comando del componente

ID operazione:
Devices_GetComponentCommandResponse_V1

Ottenere l'ultima risposta per un comando del componente del dispositivo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Componente del dispositivo
 component_name True string

Nome del componente del dispositivo.
Comando dispositivo
 command_name True string

Nome del comando del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere la risposta del comando del componente del modulo

ID operazione:
Devices_GetModuleComponentCommandResponse_V1

Ottenere l'ultima risposta per un comando del componente del modulo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Modulo dispositivo
 module True string

Nome del modulo del dispositivo.
Componente del dispositivo
 component_name True string

Nome del componente del dispositivo.
Comando dispositivo
 command_name True string

Nome del comando del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere la risposta del comando del dispositivo

ID operazione:
Devices_GetCommandResponse_V1

Ottenere l'ultima risposta per un comando del dispositivo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Comando dispositivo
 command_name True string

Nome del comando del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere la risposta del comando del modulo

ID operazione:
Devices_GetModuleCommandResponse_V1

Ottenere l'ultima risposta per un comando del modulo del dispositivo

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Modulo dispositivo
 module True string

Nome del modulo del dispositivo.
Comando dispositivo
 command_name True string

Nome del comando del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere le proprietà cloud del dispositivo (obsoleto)

ID operazione:
Devices_GetCloudProperties

Ottenere tutti i valori delle proprietà cloud di un dispositivo in base all'ID dispositivo (deprecato).

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
ID modello di dispositivo
 instanceOf string

Definizione del modello di dispositivo per il dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere le proprietà del dispositivo

ID operazione:
Devices_GetProperties_V1

Ottenere tutti i valori delle proprietà di un dispositivo in base all'ID dispositivo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere le proprietà del dispositivo (deprecato)

ID operazione:
Devices_GetProperties

Ottenere tutti i valori delle proprietà di un dispositivo in base all'ID dispositivo (deprecato).

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
ID modello di dispositivo
 instanceOf string

Definizione del modello di dispositivo per il dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere le proprietà del modulo

ID operazione:
Devices_GetModuleProperties_V1

Ottenere tutti i valori delle proprietà di un modulo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
Modulo dispositivo
 module True string

Nome del modulo del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere processi in base all'ID processo pianificato

ID operazione:
ScheduledJobs_ListJobs

Ottenere l'elenco dei processi per una definizione di processo pianificata.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID processo pianificato
 scheduled_job_id True string

ID univoco del processo pianificato.

Restituisce

Risultati di paging delle definizioni di processi appartenenti a un processo pianificato.

Corpo
ScheduledJobJobCollection

Ottenere un'organizzazione

ID operazione:
Organizations_Get

Ottenere informazioni dettagliate su un'organizzazione esistente in base all'ID.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID organizzazione
 organization_id True string

ID univoco dell'organizzazione.

Restituisce

Corpo
Organization

Ottenere un dispositivo in base all'ID (deprecato)

ID operazione:
Devices_Get

Ottenere informazioni dettagliate su un dispositivo esistente in base all'ID dispositivo (deprecato).

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.

Restituisce

Corpo
Device

Ottenere un gruppo di dispositivi

ID operazione:
DeviceGroups_Get

Ottenere informazioni dettagliate su un gruppo di dispositivi esistente in base all'ID.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID gruppo di dispositivi
 device_group_id True string

ID univoco del gruppo di dispositivi.

Restituisce

Definizione del gruppo di dispositivi.

Corpo
DeviceGroup

Ottenere un modello di dispositivo in base all'ID

ID operazione:
DeviceTemplates_Get_V1

Ottenere informazioni dettagliate su un modello di dispositivo esistente in base all'ID.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
Template
 template_id True string

ID univoco del modello.

Restituisce

Corpo
DeviceTemplateV1

Ottenere un processo

ID operazione:
Jobs_Get

Ottenere informazioni dettagliate su un processo esistente in base all'ID.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID lavoro
 job_id True string

ID univoco del processo.

Restituisce

Definizione del processo.

Corpo
JobStatic

Ottenere un processo pianificato

ID operazione:
ScheduledJobs_Get

Ottenere informazioni dettagliate su un processo pianificato esistente in base all'ID.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID processo pianificato
 scheduled_job_id True string

ID univoco del processo pianificato.

Restituisce

Gli output di questa operazione sono dinamici.

Ottenere una relazione tra dispositivi

ID operazione:
DeviceRelationships_Get

Ottenere informazioni dettagliate su una relazione di dispositivo esistente in base all'ID dispositivo e all'ID relazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.
ID relazione
 relationship_id True string

ID univoco della relazione del dispositivo.

Restituisce

Corpo
DeviceRelationshipStatic

Ottieni un dispositivo per ID

ID operazione:
Devices_Get_V1

Ottenere informazioni dettagliate su un dispositivo esistente in base all'ID dispositivo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID del dispositivo
 device_id True string

ID univoco del dispositivo.

Restituisce

Corpo
DeviceV1

Riprendere un processo arrestato

ID operazione:
Jobs_Resume

Riprendere l'esecuzione di un processo arrestato esistente.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID lavoro
 job_id True string

ID univoco del processo.

Riprendere un processo nei dispositivi non riusciti

ID operazione:
Jobs_Rerun

Eseguire una riesecuzione di un processo esistente in tutti i dispositivi non riusciti.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID lavoro
 job_id True string

ID univoco del processo.
ID di riesecuzione
 rerun_id True string

ID univoco della riesecuzione.

Restituisce

Definizione del processo.

Corpo
JobStatic

Trigger

Quando viene attivata una regola

Creare un'azione che si attiva quando viene attivata una regola in IoT Central.

Quando viene attivata una regola

ID operazione:
Workflow_CreateTrigger

Creare un'azione che si attiva quando viene attivata una regola in IoT Central.

Parametri

Nome Chiave Necessario Tipo Descrizione
Applicazione
 application True string

ID univoco dell'applicazione.
ID trigger flusso di lavoro
 id string

ID univoco del trigger del flusso di lavoro.
Regola
 rule True string

ID univoco della regola associata al trigger del flusso di lavoro.

Restituisce

Gli output di questa operazione sono dinamici.

Definizioni

Device

Nome Percorso Tipo Descrizione
ID del dispositivo
 id string

ID univoco del dispositivo.
Nome dispositivo
 displayName string

Nome visualizzato del dispositivo.
Modello di dispositivo
 instanceOf string

Definizione del modello di dispositivo per il dispositivo.
Simulato
 simulated boolean

Indica se il dispositivo è simulato.
Approvato
 approved boolean

Indica se il dispositivo è stato approvato per la connessione a IoT Central.
Sottoposto a provisioning
 provisioned boolean

Indica se le risorse sono state allocate per il dispositivo.

DeviceV1

Nome Percorso Tipo Descrizione
ID del dispositivo
 id string

ID univoco del dispositivo.
Nome dispositivo
 displayName string

Nome visualizzato del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.
Simulato
 simulated boolean

Indica se il dispositivo è simulato.
Enabled
 enabled boolean

Indica se la connessione del dispositivo a IoT Central è stata abilitata.
Sottoposto a provisioning
 provisioned boolean

Indica se le risorse sono state allocate per il dispositivo.

DeviceV2

Nome Percorso Tipo Descrizione
ID del dispositivo
 id string

ID univoco del dispositivo.
Nome dispositivo
 displayName string

Nome visualizzato del dispositivo.
Modello di dispositivo
 template string

Definizione del modello di dispositivo per il dispositivo.
Simulato
 simulated boolean

Indica se il dispositivo è simulato.
Enabled
 enabled boolean

Indica se la connessione del dispositivo a IoT Central è stata abilitata.
Organizations
 organizations array of string

L'elenco delle organizzazioni del dispositivo, attualmente è supportata solo un'organizzazione, più organizzazioni saranno presto supportate.
Sottoposto a provisioning
 provisioned boolean

Indica se le risorse sono state allocate per il dispositivo.

DeviceCollectionV1

Nome Percorso Tipo Descrizione
value
 value array of DeviceV1

Raccolta di dispositivi.
nextLink
 nextLink string

URL per ottenere la pagina successiva dei dispositivi.

DeviceGroup

Definizione del gruppo di dispositivi.

Nome Percorso Tipo Descrizione
ID gruppo di dispositivi
 id string

ID univoco del gruppo di dispositivi.
Nome visualizzato
 displayName string

Nome visualizzato del gruppo di dispositivi.
Filter
 filter string

Query che definisce quali dispositivi devono trovarsi in questo gruppo.
Description
 description string

Breve riepilogo del gruppo di dispositivi.
ETag
 etag string

ETag usato per evitare conflitti negli aggiornamenti del gruppo di dispositivi.
Organizations
 organizations array of string

Elenco di organizzazioni del gruppo di dispositivi, attualmente supportata solo un'organizzazione, più organizzazioni saranno presto supportate.

DeviceGroupCollection

Risultati di paging dei gruppi di dispositivi.

Nome Percorso Tipo Descrizione
ID gruppo di dispositivi
 value array of DeviceGroup

Raccolta di gruppi di dispositivi.
nextLink
 nextLink string

URL per ottenere la pagina successiva dei gruppi di dispositivi.

DeviceGroupDeviceCollection

Risultati di paging dei dispositivi appartenenti al gruppo di dispositivi.

Nome Percorso Tipo Descrizione
value
 value array of DeviceV1

Raccolta di dispositivi appartenenti al gruppo di dispositivi.
nextLink
 nextLink string

URL per ottenere la pagina successiva dei dispositivi nel gruppo.

DeviceRelationshipStatic

Nome Percorso Tipo Descrizione
ID relazione dispositivo
 id string

ID univoco della relazione del dispositivo.
ID origine relazione dispositivo
 source string

ID dispositivo del dispositivo di origine (padre).
ID destinazione relazione dispositivo
 target string

ID dispositivo del dispositivo di origine (figlio).

DeviceRelationshipCollection

Nome Percorso Tipo Descrizione
value
 value array of DeviceRelationshipStatic

Raccolta di relazioni tra dispositivi.
nextLink
 nextLink string

URL per ottenere la pagina successiva delle relazioni tra dispositivi.

DeviceTemplateV1

Nome Percorso Tipo Descrizione
ID modello di dispositivo
 @id string

ID univoco del modello di dispositivo.
Tipi di modello di dispositivo
 @type array of string

Tipi di JSON-LD di questo modello di dispositivo.
Nome modello di dispositivo
 displayName string

Nome visualizzato del modello di dispositivo.
Descrizione del modello di dispositivo
 description string

Descrizione dettagliata del modello di dispositivo.
Modello di funzionalità del modello di dispositivo
 capabilityModel

Modello di funzionalità utilizzato da questo modello di dispositivo.

DeviceTemplateCollectionV1

Nome Percorso Tipo Descrizione
value
 value array of DeviceTemplateV1

Raccolta di modelli di dispositivo.
nextLink
 nextLink string

URL per ottenere la pagina successiva dei modelli di dispositivo.

JobDeviceStatus

Definizione dello stato del dispositivo del processo.

Nome Percorso Tipo Descrizione
ID del dispositivo
 id string

ID del dispositivo di cui viene fornito lo stato del processo.
Stato dispositivo
 status string

Indica se il processo viene avviato, in esecuzione e così via per il dispositivo specificato.

JobDeviceStatusCollection

Risultati di paging degli stati del dispositivo del processo.

Nome Percorso Tipo Descrizione
value
 value array of JobDeviceStatus

Raccolta di stati del dispositivo del processo.
nextLink
 nextLink string

URL per ottenere la pagina successiva degli stati del dispositivo del processo.

JobBatch

Definizione del batch del processo.

Nome Percorso Tipo Descrizione
Tipo batch
 type string

Indica se l'invio in batch viene eseguito su un numero specificato di dispositivi o una percentuale del totale dei dispositivi.
Valore batch
 value number

Numero o percentuale di dispositivi in cui viene eseguita l'invio in batch.

JobCancellationThreshold

Definizione della soglia di annullamento del processo.

Nome Percorso Tipo Descrizione
Tipo soglia annullamento
 type string

Indica se la soglia di annullamento è per un numero specificato di dispositivi o una percentuale del totale dei dispositivi.
Valore soglia annullamento
 value number

Numero o percentuale di dispositivi in cui viene applicata la soglia di annullamento.
Batch soglia di annullamento
 batch boolean

Indica se la soglia di annullamento si applica per batch o al processo complessivo.

JobStatic

Definizione del processo.

Nome Percorso Tipo Descrizione
ID lavoro
 id string

ID univoco del processo.
Nome visualizzato
 displayName string

Nome visualizzato del processo.
Description
 description string

Descrizione dettagliata del processo.
Gruppo di dispositivi
 group string

ID del gruppo di dispositivi in cui eseguire il processo.
lotto
 batch JobBatch

Definizione del batch del processo.
cancellationThreshold
 cancellationThreshold JobCancellationThreshold

Definizione della soglia di annullamento del processo.
Data
 data array of object

Dati correlati all'operazione eseguita da questo processo. Tutte le voci devono essere dello stesso tipo.
items
 data object
Organizations
 organizations array of string

Elenco di organizzazioni del lavoro, attualmente supportata solo un'organizzazione, più organizzazioni saranno presto supportate.
ID processo pianificato
 scheduledJobId string

ID della definizione del processo pianificata che ha creato questo processo.

JobCollection

Risultati di paging dei processi.

Nome Percorso Tipo Descrizione
value
 value array of JobStatic

Raccolta di processi.
nextLink
 nextLink string

URL per ottenere la pagina successiva dei processi.

Organizzazione

Nome Percorso Tipo Descrizione
ID organizzazione
 id string

ID univoco dell'organizzazione.
Nome organizzazione
 displayName string

Nome visualizzato dell'organizzazione.
Parent
 parent string

Nome visualizzato dell'organizzazione padre.

OrganizationCollection

Nome Percorso Tipo Descrizione
value
 value array of Organization

Raccolta di organizzazioni.
nextLink
 nextLink string

URL per ottenere la pagina successiva delle organizzazioni.

RoleV1

Nome Percorso Tipo Descrizione
id
 id string

ID univoco del ruolo.
nome visualizzato
 displayName string

Nome visualizzato del ruolo.

RoleCollectionV1

Nome Percorso Tipo Descrizione
value
 value array of RoleV1

Raccolta di ruoli.

ScheduledJobStatic

Definizione del processo pianificato.

Nome Percorso Tipo Descrizione
ETag
 etag string

ETag usato per evitare conflitti negli aggiornamenti pianificati dei processi.
ID processo pianificato
 id string

ID univoco del processo pianificato.
Nome visualizzato
 displayName string

Nome visualizzato del processo pianificato.
Description
 description string

Descrizione dettagliata del processo pianificato.
Gruppo di dispositivi
 group string

ID del gruppo di dispositivi in cui eseguire il processo.
lotto
 batch JobBatch

Definizione del batch del processo.
cancellationThreshold
 cancellationThreshold JobCancellationThreshold

Definizione della soglia di annullamento del processo.
Data
 data array of object

Dati correlati all'operazione eseguita da questo processo. Tutte le voci devono essere dello stesso tipo.
items
 data object
Organizations
 organizations array of string

Elenco di organizzazioni del lavoro, attualmente supportata solo un'organizzazione, più organizzazioni saranno presto supportate.
Calendario
 schedule object

Pianificazione in corrispondenza della quale eseguire il processo.
Enabled
 enabled boolean

Indica se il processo pianificato è abilitato.
Finito
 completed boolean

Indica se il processo pianificato è stato completato.

ScheduledJobJobCollection

Risultati di paging delle definizioni di processi appartenenti a un processo pianificato.

Nome Percorso Tipo Descrizione
value
 value array of JobStatic

Raccolta di processi.
nextLink
 nextLink string

URL per ottenere la pagina successiva dei processi.

UserStaticV1

Nome Percorso Tipo Descrizione
ID utente
 id string

ID univoco dell'utente.
Tipo utente
 type string

Tipo di utente.
Ruoli
 roles array of RoleAssignmentV1

Elenco di assegnazioni di ruolo che specificano le autorizzazioni per accedere all'applicazione.

UserCollectionV1

Nome Percorso Tipo Descrizione
Users
 value array of UserStaticV1

Raccolta di utenti.

RoleAssignmentV1

Nome Percorso Tipo Descrizione
Ruolo
 role string

ID del ruolo per questa assegnazione di ruolo.