Udostępnij przez

Azure IoT Central V3 (wersja zapoznawcza)

Usługa Azure IoT Central ułatwia łączenie, monitorowanie i zarządzanie urządzeniami IoT na dużą skalę. Za pomocą łącznika usługi IoT Central w wersji 3 można wyzwalać przepływy pracy po wyzwoleniu reguły i wykonywać akcje, wykonując polecenia, aktualizując właściwości, pobierając dane telemetryczne z urządzeń i nie tylko. Użyj tego łącznika z aplikacją usługi Azure IoT Central w wersji 3.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Pomoc techniczna dotycząca usługi Azure IoT Central
adres URL https://aka.ms/iotcentral-create-technical-support-ticket-trial
Metadane łącznika
Publisher Microsoft Corporation
Witryna internetowa https://azure.microsoft.com/services/iot-central/
Zasady ochrony prywatności https://privacy.microsoft.com
Kategorie Internet rzeczy

Łącznik usługi Azure IoT Central w wersji 3 może służyć do łączenia aplikacji usługi Azure IoT Central w wersji 3 z przepływami pracy. Łącznik umożliwia uruchamianie przepływów pracy po wyzwoleniu reguły. Można go użyć, aby uzyskać najnowsze informacje z urządzeń IoT, takich jak dane telemetryczne i właściwości. Można również użyć go do aktualizowania urządzeń IoT, wysyłając polecenia i aktualizując odpowiednie witryny.

Wymagania wstępne

  • Aby korzystać z tego łącznika, musisz być użytkownikiem aplikacji usługi Azure IoT Central w wersji 3 z płatnościąYou-Go zgodnie z rzeczywistym użyciem.
  • Musisz użyć konta służbowego microsoft Entra ID.

Jak uzyskać poświadczenia

Aby dodać ten łącznik do przepływu pracy, musisz najpierw zalogować się do konta służbowego Microsoft Entra ID, z którym jest użytkownik w aplikacji usługi Azure IoT Central, z którą chcesz się połączyć.

Informacje o wydaniu

Wrzesień 2021

  • Łącznik usługi Azure IoT Central w wersji 3 został zaktualizowany tak, aby był zgodny z naszą ogólnie dostępną powierzchnią interfejsu API REST w wersji 1.0 . Wszystkie akcje łącznika obsługują teraz format DTDLv2 i obsługę modeli opartych na dtDLv1 jest przestarzały.
  • Akcje do Run a device command, Get/Update device propertiesi Get device telemetry value zostały zaktualizowane w celu dodania obsługi do najnowszych funkcji szablonu urządzenia w usłudze Azure IoT Central. Te akcje obsługują teraz zarówno funkcje katalogu głównego, jak i składnika.
  • Dodano nowy zestaw akcji modułu urządzenia. Te akcje umożliwiają tworzenie przepływów pracy, które współdziałają z poleceniami, właściwościami, telemetriami zarówno modułów urządzeń, jak i składników modułów.
  • Akcje, które mają zostać zaktualizowane w celu Get/Create/Update/Delete a device dostosowania do najnowszego interfejsu API REST usługi Azure IoT Central.
  • Get device cloud properties Akcje i Update device cloud properties są teraz częścią elementów Get device properties i Update device properties. Nowe akcje umożliwiają przepływom pracy interakcję zarówno z właściwościami urządzenia, jak i właściwościami chmury jednocześnie.

Powiadomienie o wycofaniu: do końca CY21 akcje oznaczone jako przestarzałe na poniższej liście nie będą już dostępne podczas tworzenia nowych przepływów pracy. Istniejące przepływy pracy odwołujące się do tych akcji będą nadal działać do marca 2022 r. Zachęcamy do zaktualizowania przepływów pracy w celu skorzystania z nowo ogłoszonych akcji, które są teraz obsługiwane w usłudze Azure IoT Central.

Listopad 2021 r.

  • Dodano nowe akcje służące do wyświetlania listy urządzeń i szablonów urządzeń dla aplikacji usługi Azure IoT Central. Te akcje obejmują obsługę stronicowania.
  • Dodano nowy zestaw akcji zarządzania użytkownikami do łącznika, co umożliwia przepływom pracy tworzenie, aktualizowanie, wyświetlanie listy i usuwanie użytkowników aplikacji.
  • Przepływy pracy mogą teraz uzyskać najnowsze wykonanie polecenia urządzenia przy użyciu nowych Get device command response akcji. Ten zestaw akcji obsługuje polecenia katalogu głównego, składnika i modułu.

Znane problemy i ograniczenia

  • Aby korzystać z tego łącznika w usłudze Microsoft Power Automate, musisz zalogować się do aplikacji usługi IoT Central co najmniej raz. W przeciwnym razie aplikacja nie będzie wyświetlana na liście rozwijanej Aplikacja
  • Konta osobiste Microsoft (takie jak @hotmail.com, @live.com, @outlook.com domeny) nie są obsługiwane do logowania się do łącznika usługi IoT Central. Musisz użyć konta służbowego microsoft Entra ID.

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:
Credentials Credentials Wszystkie regiony Nie można udostępniać
Domyślne [PRZESTARZAŁE] Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami. Wszystkie regiony Nie można udostępniać

Credentials

Identyfikator uwierzytelniania: 1stparty

Dotyczy: wszystkie regiony

Credentials

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Domyślne [PRZESTARZAŁE]

Dotyczy: wszystkie regiony

Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Aktualizowanie relacji urządzenia

Zaktualizuj istniejącą relację urządzenia między danym urządzeniem a nowym urządzeniem, biorąc pod uwagę identyfikator urządzenia i identyfikator relacji.
Aktualizowanie użytkownika

Aktualizowanie użytkownika w aplikacji za pomocą poprawki
Aktualizowanie właściwości modułu

Zaktualizuj wszystkie wartości właściwości modułu.
Aktualizowanie właściwości urządzenia

Zaktualizuj wszystkie wartości właściwości urządzenia według identyfikatora urządzenia.
Aktualizowanie właściwości urządzenia (przestarzałe)

Zaktualizuj wszystkie wartości właściwości urządzenia według identyfikatora urządzenia (przestarzałe).
Aktualizowanie właściwości urządzeń w chmurze (przestarzałe)

Zaktualizuj wszystkie wartości właściwości chmury urządzenia według identyfikatora urządzenia (przestarzałe).
Aktualizowanie zaplanowanego zadania

Zaktualizuj istniejące zaplanowane zadanie według identyfikatora.
Lista relacji

Wyświetl listę wszystkich relacji na podstawie identyfikatora urządzenia.
Pobieranie grupy urządzeń

Uzyskaj szczegółowe informacje o istniejącej grupie urządzeń według identyfikatora.
Pobieranie szablonu urządzenia według identyfikatora

Uzyskaj szczegółowe informacje o istniejącym szablonie urządzenia według identyfikatora.
Pobieranie urządzenia według identyfikatora (przestarzałe)

Uzyskaj szczegółowe informacje o istniejącym urządzeniu według identyfikatora urządzenia (przestarzałe).
Pobieranie urządzeń według identyfikatora grupy urządzeń

Pobierz listę urządzeń w grupie urządzeń w aplikacji.
Pobieranie użytkownika

Pobieranie użytkownika według identyfikatora
Pobieranie wartości telemetrii modułu

Pobierz ostatnią wartość telemetrii z modułu.
Pobieranie wartości telemetrii składnika

Pobierz ostatnią wartość telemetrii ze składnika.
Pobieranie wartości telemetrii składnika modułu

Pobierz ostatnią wartość telemetrii ze składnika modułu.
Pobieranie wartości telemetrii urządzenia

Pobierz ostatnią wartość telemetrii z urządzenia.
Pobieranie wartości telemetrii urządzenia (przestarzałe)

Pobierz ostatnią wartość telemetrii z urządzenia (przestarzałe).
Pobieranie właściwości chmurowych urządzenia (przestarzałe)

Pobierz wszystkie wartości właściwości chmury urządzenia według identyfikatora urządzenia (przestarzałe).
Pobieranie właściwości modułu

Pobierz wszystkie wartości właściwości modułu.
Pobieranie właściwości urządzenia

Pobierz wszystkie wartości właściwości urządzenia według identyfikatora urządzenia.
Pobieranie właściwości urządzenia (przestarzałe)

Pobierz wszystkie wartości właściwości urządzenia według identyfikatora urządzenia (przestarzałe).
Pobieranie zadania

Uzyskaj szczegółowe informacje o istniejącym zadaniu według identyfikatora.
Pobieranie zadań według identyfikatora zaplanowanego zadania

Pobierz listę zadań dla definicji zaplanowanego zadania.
Pobieranie zaplanowanego zadania

Uzyskaj szczegółowe informacje o istniejącym zaplanowanym zadaniu według identyfikatora.
Pobierz urządzenie według identyfikatora

Uzyskaj szczegółowe informacje o istniejącym urządzeniu według identyfikatora urządzenia.
Tworzenie grupy urządzeń

Utwórz lub zaktualizuj grupę urządzeń.
Tworzenie lub aktualizowanie urządzenia

Utwórz nowe urządzenie lub zaktualizuj istniejące według identyfikatora urządzenia.
Tworzenie lub aktualizowanie urządzenia (przestarzałe)

Utwórz nowe urządzenie lub zaktualizuj istniejące według identyfikatora urządzenia. (przestarzałe)
Tworzenie lub aktualizowanie urządzenia (przestarzałe)

Utwórz nowe urządzenie lub zaktualizuj istniejące według identyfikatora urządzenia (przestarzałe).
Tworzenie organizacji

Utwórz nową organizację.
Tworzenie relacji urządzenia

Utwórz nową relację urządzenia między danym urządzeniem a nowym urządzeniem przy użyciu identyfikatora urządzenia i identyfikatora relacji.
Tworzenie zaplanowanego zadania

Utwórz i wykonaj nowe zaplanowane zadanie za pomocą definicji zadania.
Uruchamianie polecenia modułu

Uruchom polecenie w module.
Uruchamianie polecenia składnika

Uruchom polecenie w składniku.
Uruchamianie polecenia składnika modułu

Uruchom polecenie w składniku modułu.
Uruchamianie polecenia urządzenia

Uruchom polecenie na urządzeniu.
Usuwanie grupy urządzeń

Usuwanie istniejącej grupy urządzeń według identyfikatora
Usuwanie organizacji

Usuwanie istniejącej organizacji według identyfikatora
Usuwanie relacji urządzenia

Usuń istniejącą relację urządzenia według identyfikatora urządzenia i identyfikatora relacji.
Usuwanie szablonu urządzenia

Usuń istniejący szablon urządzenia według identyfikatora.
Usuwanie urządzenia

Usuń istniejące urządzenie według identyfikatora urządzenia.
Usuwanie urządzenia (przestarzałe)

Usuń istniejące urządzenie według identyfikatora urządzenia (przestarzałe).
Usuwanie użytkownika

Usuwanie użytkownika
Usuwanie zaplanowanego zadania

Usuń istniejące zaplanowane zadanie według identyfikatora.
Utwórz pracę

Utwórz i wykonaj nowe zadanie za pomocą definicji zadania.
Utwórz użytkownika

Tworzenie użytkownika w aplikacji
Uzyskiwanie odpowiedzi na polecenie modułu

Pobieranie ostatniej odpowiedzi dla polecenia modułu urządzenia
Uzyskiwanie odpowiedzi na polecenie składnika

Pobierz ostatnią odpowiedź dla polecenia składnika urządzenia.
Uzyskiwanie odpowiedzi na polecenie składnika modułu

Pobierz ostatnią odpowiedź dla polecenia składnika modułu.
Uzyskiwanie odpowiedzi na polecenie urządzenia

Pobierz ostatnią odpowiedź dla polecenia urządzenia.
Uzyskiwanie organizacji

Uzyskaj szczegółowe informacje o istniejącej organizacji według identyfikatora.
Uzyskiwanie relacji urządzenia

Uzyskaj szczegółowe informacje o istniejącej relacji urządzenia według identyfikatora urządzenia i identyfikatora relacji.
Uzyskiwanie roli

Pobierz rolę według identyfikatora.
Uzyskiwanie stanu urządzenia

Pobierz listę stanów poszczególnych urządzeń według identyfikatora zadania.
Wykonywanie polecenia urządzenia (przestarzałe)

Wykonaj polecenie na urządzeniu (przestarzałe).
Wyświetl listę urządzeń

Pobierz listę urządzeń w aplikacji.
Wyświetlanie listy grup urządzeń

Pobierz listę grup urządzeń w aplikacji.
Wyświetlanie listy organizacji

Pobierz listę organizacji w aplikacji.
Wyświetlanie listy ról

Pobierz listę ról w aplikacji.
Wyświetlanie listy szablonów urządzeń

Pobierz listę szablonów urządzeń w aplikacji.
Wyświetlanie listy użytkowników

Pobieranie listy użytkowników w aplikacji
Wyświetlanie listy zadań

Pobierz listę zadań w aplikacji.
Wyświetlanie listy zaplanowanych zadań

Pobierz listę zaplanowanych zadań w aplikacji.
Wznawianie zadania na urządzeniach, które zakończyły się niepowodzeniem

Wykonaj ponowne uruchomienie istniejącego zadania na wszystkich urządzeniach, które zakończyły się niepowodzeniem.
Wznawianie zatrzymanego zadania

Wznów wykonywanie istniejącego zatrzymanego zadania.
Zatrzymywanie uruchomionego zadania

Zatrzymaj wykonywanie zadania, które jest aktualnie uruchomione.

Aktualizowanie relacji urządzenia

Identyfikator operacji:
DeviceRelationships_Update

Zaktualizuj istniejącą relację urządzenia między danym urządzeniem a nowym urządzeniem, biorąc pod uwagę identyfikator urządzenia i identyfikator relacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Identyfikator relacji
 relationship_id True string

Unikatowy identyfikator relacji urządzenia.
Identyfikator relacji urządzenia
 id string

Unikatowy identyfikator relacji urządzenia.
Identyfikator docelowy relacji urządzenia
 target True string

Identyfikator urządzenia źródłowego (podrzędnego).

Zwraca

Body
DeviceRelationshipStatic

Aktualizowanie użytkownika

Identyfikator operacji:
Users_Update_V1

Aktualizowanie użytkownika w aplikacji za pomocą poprawki

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
User
 user_id True string

Unikatowy identyfikator użytkownika.
Typ użytkownika
 user_type string

Typ użytkownika.
Body
 body True dynamic

Treść aktualizacji użytkownika.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Aktualizowanie właściwości modułu

Identyfikator operacji:
Devices_UpdateModuleProperties_V1

Zaktualizuj wszystkie wartości właściwości modułu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Moduł urządzenia
 module True string

Nazwa modułu urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.
body
 body True dynamic

Właściwości urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Aktualizowanie właściwości urządzenia

Identyfikator operacji:
Devices_UpdateProperties_V1

Zaktualizuj wszystkie wartości właściwości urządzenia według identyfikatora urządzenia.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.
body
 body True dynamic

Właściwości urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Aktualizowanie właściwości urządzenia (przestarzałe)

Identyfikator operacji:
Devices_UpdateProperties

Zaktualizuj wszystkie wartości właściwości urządzenia według identyfikatora urządzenia (przestarzałe).

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Identyfikator szablonu urządzenia
 instanceOf string

Definicja szablonu urządzenia dla urządzenia.
body
 body True dynamic

Właściwości urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Aktualizowanie właściwości urządzeń w chmurze (przestarzałe)

Identyfikator operacji:
Devices_UpdateCloudProperties

Zaktualizuj wszystkie wartości właściwości chmury urządzenia według identyfikatora urządzenia (przestarzałe).

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Identyfikator szablonu urządzenia
 instanceOf string

Definicja szablonu urządzenia dla urządzenia.
body
 body True dynamic

Właściwości urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Aktualizowanie zaplanowanego zadania

Identyfikator operacji:
ScheduledJobs_Update

Zaktualizuj istniejące zaplanowane zadanie według identyfikatora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator zaplanowanego zadania
 scheduled_job_id True string

Unikatowy identyfikator zaplanowanego zadania.
Typ zakończenia harmonogramu
 scheduled_job_end_type string

Jak zaplanowane zadanie powinno zostać zakończone (nie ma zastosowania do migracji szablonów urządzeń).
Body
 body True dynamic

Treść tworzenia zaplanowanego zadania.

Zwraca

Definicja zaplanowanego zadania.

Body
ScheduledJobStatic

Lista relacji

Identyfikator operacji:
DeviceRelationships_List

Wyświetl listę wszystkich relacji na podstawie identyfikatora urządzenia.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.

Zwraca

Body
DeviceRelationshipCollection

Pobieranie grupy urządzeń

Identyfikator operacji:
DeviceGroups_Get

Uzyskaj szczegółowe informacje o istniejącej grupie urządzeń według identyfikatora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator grupy urządzeń
 device_group_id True string

Unikatowy identyfikator grupy urządzeń.

Zwraca

Definicja grupy urządzeń.

Body
DeviceGroup

Pobieranie szablonu urządzenia według identyfikatora

Identyfikator operacji:
DeviceTemplates_Get_V1

Uzyskaj szczegółowe informacje o istniejącym szablonie urządzenia według identyfikatora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Template
 template_id True string

Unikatowy identyfikator szablonu.

Zwraca

Body
DeviceTemplateV1

Pobieranie urządzenia według identyfikatora (przestarzałe)

Identyfikator operacji:
Devices_Get

Uzyskaj szczegółowe informacje o istniejącym urządzeniu według identyfikatora urządzenia (przestarzałe).

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.

Zwraca

Body
Device

Pobieranie urządzeń według identyfikatora grupy urządzeń

Identyfikator operacji:
DeviceGroups_GetDevices

Pobierz listę urządzeń w grupie urządzeń w aplikacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator grupy urządzeń
 device_group_id True string

Unikatowy identyfikator grupy urządzeń.

Zwraca

Stronicowane wyniki urządzeń należących do grupy urządzeń.

Body
DeviceGroupDeviceCollection

Pobieranie użytkownika

Identyfikator operacji:
Users_Get_V1

Pobieranie użytkownika według identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
User
 user_id True string

Unikatowy identyfikator użytkownika.

Zwraca

Body
UserStaticV1

Pobieranie wartości telemetrii modułu

Identyfikator operacji:
Devices_GetModuleTelemetryValue_V1

Pobierz ostatnią wartość telemetrii z modułu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Moduł urządzenia
 module True string

Nazwa modułu urządzenia.
Telemetria urządzenia
 telemetry_name True string

Nazwa tej telemetrii urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Pobieranie wartości telemetrii składnika

Identyfikator operacji:
Devices_GetComponentTelemetryValue_V1

Pobierz ostatnią wartość telemetrii ze składnika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Składnik urządzenia
 component_name True string

Nazwa składnika urządzenia.
Telemetria urządzenia
 telemetry_name True string

Nazwa tej telemetrii urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Pobieranie wartości telemetrii składnika modułu

Identyfikator operacji:
Devices_GetModuleComponentTelemetryValue_V1

Pobierz ostatnią wartość telemetrii ze składnika modułu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Moduł urządzenia
 module True string

Nazwa modułu urządzenia.
Składnik urządzenia
 component_name True string

Nazwa składnika urządzenia.
Telemetria urządzenia
 telemetry_name True string

Nazwa tej telemetrii urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Pobieranie wartości telemetrii urządzenia

Identyfikator operacji:
Devices_GetTelemetryValue_V1

Pobierz ostatnią wartość telemetrii z urządzenia.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Telemetria urządzenia
 telemetry_name True string

Nazwa tej telemetrii urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Pobieranie wartości telemetrii urządzenia (przestarzałe)

Identyfikator operacji:
Devices_GetComponentTelemetryValue

Pobierz ostatnią wartość telemetrii z urządzenia (przestarzałe).

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Składnik urządzenia
 component_name True string

Nazwa składnika urządzenia.
Telemetria urządzenia
 telemetry_name True string

Nazwa tej telemetrii urządzenia.
Identyfikator szablonu urządzenia
 instanceOf string

Definicja szablonu urządzenia dla urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Pobieranie właściwości chmurowych urządzenia (przestarzałe)

Identyfikator operacji:
Devices_GetCloudProperties

Pobierz wszystkie wartości właściwości chmury urządzenia według identyfikatora urządzenia (przestarzałe).

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Identyfikator szablonu urządzenia
 instanceOf string

Definicja szablonu urządzenia dla urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Pobieranie właściwości modułu

Identyfikator operacji:
Devices_GetModuleProperties_V1

Pobierz wszystkie wartości właściwości modułu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Moduł urządzenia
 module True string

Nazwa modułu urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Pobieranie właściwości urządzenia

Identyfikator operacji:
Devices_GetProperties_V1

Pobierz wszystkie wartości właściwości urządzenia według identyfikatora urządzenia.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Pobieranie właściwości urządzenia (przestarzałe)

Identyfikator operacji:
Devices_GetProperties

Pobierz wszystkie wartości właściwości urządzenia według identyfikatora urządzenia (przestarzałe).

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Identyfikator szablonu urządzenia
 instanceOf string

Definicja szablonu urządzenia dla urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Pobieranie zadania

Identyfikator operacji:
Jobs_Get

Uzyskaj szczegółowe informacje o istniejącym zadaniu według identyfikatora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator zadania
 job_id True string

Unikatowy identyfikator zadania.

Zwraca

Definicja zadania.

Body
JobStatic

Pobieranie zadań według identyfikatora zaplanowanego zadania

Identyfikator operacji:
ScheduledJobs_ListJobs

Pobierz listę zadań dla definicji zaplanowanego zadania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator zaplanowanego zadania
 scheduled_job_id True string

Unikatowy identyfikator zaplanowanego zadania.

Zwraca

Stronicowane wyniki definicji zadań należących do zaplanowanego zadania.

Body
ScheduledJobJobCollection

Pobieranie zaplanowanego zadania

Identyfikator operacji:
ScheduledJobs_Get

Uzyskaj szczegółowe informacje o istniejącym zaplanowanym zadaniu według identyfikatora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator zaplanowanego zadania
 scheduled_job_id True string

Unikatowy identyfikator zaplanowanego zadania.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Pobierz urządzenie według identyfikatora

Identyfikator operacji:
Devices_Get_V1

Uzyskaj szczegółowe informacje o istniejącym urządzeniu według identyfikatora urządzenia.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.

Zwraca

Body
DeviceV1

Tworzenie grupy urządzeń

Identyfikator operacji:
DeviceGroups_Set

Utwórz lub zaktualizuj grupę urządzeń.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator grupy urządzeń
 device_group_id True string

Unikatowy identyfikator grupy urządzeń.
Identyfikator grupy urządzeń
 id string

Unikatowy identyfikator grupy urządzeń.
Wyświetlana nazwa
 displayName True string

Nazwa wyświetlana grupy urządzeń.
Filter
 filter True string

Zapytanie definiujące, które urządzenia powinny znajdować się w tej grupie.
Description
 description string

Krótkie podsumowanie grupy urządzeń.
ETag
 etag string

Element ETag używany do zapobiegania konfliktom w aktualizacjach grup urządzeń.
Organizations
 organizations array of string

Lista organizacji grupy urządzeń, tylko jedna organizacja jest obecnie obsługiwana, wiele organizacji będzie obsługiwanych wkrótce.

Zwraca

Definicja grupy urządzeń.

Body
DeviceGroup

Tworzenie lub aktualizowanie urządzenia

Identyfikator operacji:
Devices_Set_V2

Utwórz nowe urządzenie lub zaktualizuj istniejące według identyfikatora urządzenia.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Identyfikator urządzenia
 id string

Unikatowy identyfikator urządzenia.
Nazwa urządzenia
 displayName string

Nazwa wyświetlana urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.
Symulowany
 simulated boolean

Czy urządzenie jest symulowane.
Włączona
 enabled boolean

Czy połączenie urządzenia z usługą IoT Central zostało włączone.
Organizations
 organizations array of string

Lista organizacji urządzenia, tylko jedna organizacja jest obecnie obsługiwana, wiele organizacji będzie obsługiwanych wkrótce.
Udostępnione
 provisioned boolean

Określa, czy zasoby zostały przydzielone dla urządzenia.

Zwraca

Body
DeviceV2

Tworzenie lub aktualizowanie urządzenia (przestarzałe)

Identyfikator operacji:
Devices_Set_V1

Utwórz nowe urządzenie lub zaktualizuj istniejące według identyfikatora urządzenia. (przestarzałe)

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Identyfikator urządzenia
 id string

Unikatowy identyfikator urządzenia.
Nazwa urządzenia
 displayName string

Nazwa wyświetlana urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.
Symulowany
 simulated boolean

Czy urządzenie jest symulowane.
Włączona
 enabled boolean

Czy połączenie urządzenia z usługą IoT Central zostało włączone.
Udostępnione
 provisioned boolean

Określa, czy zasoby zostały przydzielone dla urządzenia.

Zwraca

Body
DeviceV1

Tworzenie lub aktualizowanie urządzenia (przestarzałe)

Identyfikator operacji:
Devices_Set

Utwórz nowe urządzenie lub zaktualizuj istniejące według identyfikatora urządzenia (przestarzałe).

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Identyfikator urządzenia
 id string

Unikatowy identyfikator urządzenia.
Nazwa urządzenia
 displayName string

Nazwa wyświetlana urządzenia.
Szablon urządzenia
 instanceOf string

Definicja szablonu urządzenia dla urządzenia.
Symulowany
 simulated boolean

Czy urządzenie jest symulowane.
Zatwierdzony
 approved boolean

Czy urządzenie zostało zatwierdzone do nawiązania połączenia z usługą IoT Central.
Udostępnione
 provisioned boolean

Określa, czy zasoby zostały przydzielone dla urządzenia.

Zwraca

Body
Device

Tworzenie organizacji

Identyfikator operacji:
Organizations_Set

Utwórz nową organizację.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator organizacji
 organization_id True string

Unikatowy identyfikator organizacji.
Identyfikator organizacji
 id string

Unikatowy identyfikator organizacji.
Nazwa organizacji
 displayName string

Nazwa wyświetlana organizacji.
Parent
 parent string

Nazwa wyświetlana organizacji nadrzędnej.

Zwraca

Body
Organization

Tworzenie relacji urządzenia

Identyfikator operacji:
DeviceRelationships_Set

Utwórz nową relację urządzenia między danym urządzeniem a nowym urządzeniem przy użyciu identyfikatora urządzenia i identyfikatora relacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator relacji
 relationship_id True string

Unikatowy identyfikator relacji urządzenia.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Identyfikator relacji urządzenia
 id string

Unikatowy identyfikator relacji urządzenia.
Identyfikator docelowy relacji urządzenia
 target True string

Identyfikator urządzenia źródłowego (podrzędnego).

Zwraca

Body
DeviceRelationshipStatic

Tworzenie zaplanowanego zadania

Identyfikator operacji:
ScheduledJobs_Set

Utwórz i wykonaj nowe zaplanowane zadanie za pomocą definicji zadania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator zaplanowanego zadania
 scheduled_job_id True string

Unikatowy identyfikator zaplanowanego zadania.
Typ zadania
 job_type string

Typ zadania.
Typ zakończenia harmonogramu
 scheduled_job_end_type string

Jak zaplanowane zadanie powinno zostać zakończone (nie ma zastosowania do migracji szablonów urządzeń).
Body
 body True dynamic

Treść tworzenia zaplanowanego zadania.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Uruchamianie polecenia modułu

Identyfikator operacji:
Devices_RunModuleCommand_V1

Uruchom polecenie w module.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Moduł urządzenia
 module True string

Nazwa modułu urządzenia.
Polecenie urządzenia
 command_name True string

Nazwa tego polecenia urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.
body
 body True dynamic

Treść polecenia urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Uruchamianie polecenia składnika

Identyfikator operacji:
Devices_RunComponentCommand_V1

Uruchom polecenie w składniku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Składnik urządzenia
 component_name True string

Nazwa składnika urządzenia.
Polecenie urządzenia
 command_name True string

Nazwa tego polecenia urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.
body
 body True dynamic

Treść polecenia urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Uruchamianie polecenia składnika modułu

Identyfikator operacji:
Devices_RunModuleComponentCommand_V1

Uruchom polecenie w składniku modułu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Moduł urządzenia
 module True string

Nazwa modułu urządzenia.
Składnik urządzenia
 component_name True string

Nazwa składnika urządzenia.
Polecenie urządzenia
 command_name True string

Nazwa tego polecenia urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.
body
 body True dynamic

Treść polecenia urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Uruchamianie polecenia urządzenia

Identyfikator operacji:
Devices_RunCommand_V1

Uruchom polecenie na urządzeniu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Polecenie urządzenia
 command_name True string

Nazwa tego polecenia urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.
body
 body True dynamic

Treść polecenia urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Usuwanie grupy urządzeń

Identyfikator operacji:
DeviceGroups_Remove

Usuwanie istniejącej grupy urządzeń według identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator grupy urządzeń
 device_group_id True string

Unikatowy identyfikator grupy urządzeń.

Usuwanie organizacji

Identyfikator operacji:
Organizations_Remove

Usuwanie istniejącej organizacji według identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator organizacji
 organization_id True string

Unikatowy identyfikator organizacji.

Usuwanie relacji urządzenia

Identyfikator operacji:
DeviceRelationships_Remove

Usuń istniejącą relację urządzenia według identyfikatora urządzenia i identyfikatora relacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Identyfikator relacji
 relationship_id True string

Unikatowy identyfikator relacji urządzenia.

Usuwanie szablonu urządzenia

Identyfikator operacji:
DeviceTemplates_Remove_V1

Usuń istniejący szablon urządzenia według identyfikatora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Template
 template_id True string

Unikatowy identyfikator szablonu.

Usuwanie urządzenia

Identyfikator operacji:
Devices_Remove_V1

Usuń istniejące urządzenie według identyfikatora urządzenia.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.

Usuwanie urządzenia (przestarzałe)

Identyfikator operacji:
Devices_Remove

Usuń istniejące urządzenie według identyfikatora urządzenia (przestarzałe).

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.

Usuwanie użytkownika

Identyfikator operacji:
Users_Remove_V1

Usuwanie użytkownika

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
User
 user_id True string

Unikatowy identyfikator użytkownika.

Usuwanie zaplanowanego zadania

Identyfikator operacji:
ScheduledJobs_Remove

Usuń istniejące zaplanowane zadanie według identyfikatora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator zaplanowanego zadania
 scheduled_job_id True string

Unikatowy identyfikator zaplanowanego zadania.

Utwórz pracę

Identyfikator operacji:
Jobs_Set

Utwórz i wykonaj nowe zadanie za pomocą definicji zadania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator zadania
 job_id True string

Unikatowy identyfikator zadania.
Typ zadania
 job_type string

Typ zadania.
Body
 body True dynamic

Treść tworzenia zadania.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Utwórz użytkownika

Identyfikator operacji:
Users_Create_V1

Tworzenie użytkownika w aplikacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
User
 user_id True string

Unikatowy identyfikator użytkownika.
Typ użytkownika
 user_type string

Typ użytkownika.
Body
 body True dynamic

Treść tworzenia przez użytkownika.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Uzyskiwanie odpowiedzi na polecenie modułu

Identyfikator operacji:
Devices_GetModuleCommandResponse_V1

Pobieranie ostatniej odpowiedzi dla polecenia modułu urządzenia

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Moduł urządzenia
 module True string

Nazwa modułu urządzenia.
Polecenie urządzenia
 command_name True string

Nazwa tego polecenia urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Uzyskiwanie odpowiedzi na polecenie składnika

Identyfikator operacji:
Devices_GetComponentCommandResponse_V1

Pobierz ostatnią odpowiedź dla polecenia składnika urządzenia.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Składnik urządzenia
 component_name True string

Nazwa składnika urządzenia.
Polecenie urządzenia
 command_name True string

Nazwa tego polecenia urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Uzyskiwanie odpowiedzi na polecenie składnika modułu

Identyfikator operacji:
Devices_GetModuleComponentCommandResponse_V1

Pobierz ostatnią odpowiedź dla polecenia składnika modułu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Moduł urządzenia
 module True string

Nazwa modułu urządzenia.
Składnik urządzenia
 component_name True string

Nazwa składnika urządzenia.
Polecenie urządzenia
 command_name True string

Nazwa tego polecenia urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Uzyskiwanie odpowiedzi na polecenie urządzenia

Identyfikator operacji:
Devices_GetCommandResponse_V1

Pobierz ostatnią odpowiedź dla polecenia urządzenia.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Polecenie urządzenia
 command_name True string

Nazwa tego polecenia urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Uzyskiwanie organizacji

Identyfikator operacji:
Organizations_Get

Uzyskaj szczegółowe informacje o istniejącej organizacji według identyfikatora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator organizacji
 organization_id True string

Unikatowy identyfikator organizacji.

Zwraca

Body
Organization

Uzyskiwanie relacji urządzenia

Identyfikator operacji:
DeviceRelationships_Get

Uzyskaj szczegółowe informacje o istniejącej relacji urządzenia według identyfikatora urządzenia i identyfikatora relacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Identyfikator relacji
 relationship_id True string

Unikatowy identyfikator relacji urządzenia.

Zwraca

Body
DeviceRelationshipStatic

Uzyskiwanie roli

Identyfikator operacji:
Roles_Get_V1

Pobierz rolę według identyfikatora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Role
 role_id True string

Unikatowy identyfikator roli.

Zwraca

Body
RoleV1

Uzyskiwanie stanu urządzenia

Identyfikator operacji:
Jobs_GetDevices

Pobierz listę stanów poszczególnych urządzeń według identyfikatora zadania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator zadania
 job_id True string

Unikatowy identyfikator zadania.

Zwraca

Stronicowane wyniki stanu urządzenia zadania.

Body
JobDeviceStatusCollection

Wykonywanie polecenia urządzenia (przestarzałe)

Identyfikator operacji:
Devices_ExecuteComponentCommand

Wykonaj polecenie na urządzeniu (przestarzałe).

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator urządzenia
 device_id True string

Unikatowy identyfikator urządzenia.
Składnik urządzenia
 component_name True string

Nazwa składnika urządzenia.
Polecenie urządzenia
 command_name True string

Nazwa tego polecenia urządzenia.
Identyfikator szablonu urządzenia
 instanceOf string

Definicja szablonu urządzenia dla urządzenia.
body
 body True dynamic

Treść polecenia urządzenia.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Wyświetl listę urządzeń

Identyfikator operacji:
Devices_List_V1

Pobierz listę urządzeń w aplikacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.

Zwraca

Body
DeviceCollectionV1

Wyświetlanie listy grup urządzeń

Identyfikator operacji:
DeviceGroups_List

Pobierz listę grup urządzeń w aplikacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.

Zwraca

Stronicowane wyniki grup urządzeń.

Body
DeviceGroupCollection

Wyświetlanie listy organizacji

Identyfikator operacji:
Organizations_List

Pobierz listę organizacji w aplikacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.

Zwraca

Body
OrganizationCollection

Wyświetlanie listy ról

Identyfikator operacji:
Roles_List_V1

Pobierz listę ról w aplikacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.

Zwraca

Body
RoleCollectionV1

Wyświetlanie listy szablonów urządzeń

Identyfikator operacji:
DeviceTemplates_List_V1

Pobierz listę szablonów urządzeń w aplikacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.

Zwraca

Body
DeviceTemplateCollectionV1

Wyświetlanie listy użytkowników

Identyfikator operacji:
Users_List_V1

Pobieranie listy użytkowników w aplikacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.

Zwraca

Body
UserCollectionV1

Wyświetlanie listy zadań

Identyfikator operacji:
Jobs_List

Pobierz listę zadań w aplikacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.

Zwraca

Stronicowane wyniki zadań.

Body
JobCollection

Wyświetlanie listy zaplanowanych zadań

Identyfikator operacji:
ScheduledJobs_List

Pobierz listę zaplanowanych zadań w aplikacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Wznawianie zadania na urządzeniach, które zakończyły się niepowodzeniem

Identyfikator operacji:
Jobs_Rerun

Wykonaj ponowne uruchomienie istniejącego zadania na wszystkich urządzeniach, które zakończyły się niepowodzeniem.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator zadania
 job_id True string

Unikatowy identyfikator zadania.
Identyfikator ponownego uruchamiania
 rerun_id True string

Unikatowy identyfikator ponownego uruchomienia.

Zwraca

Definicja zadania.

Body
JobStatic

Wznawianie zatrzymanego zadania

Identyfikator operacji:
Jobs_Resume

Wznów wykonywanie istniejącego zatrzymanego zadania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator zadania
 job_id True string

Unikatowy identyfikator zadania.

Zatrzymywanie uruchomionego zadania

Identyfikator operacji:
Jobs_Stop

Zatrzymaj wykonywanie zadania, które jest aktualnie uruchomione.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator zadania
 job_id True string

Unikatowy identyfikator zadania.

Wyzwalacze

Gdy reguła zostanie wyzwolona

Utwórz akcję wyzwalaną po wyzwoleniu reguły w usłudze IoT Central.

Gdy reguła zostanie wyzwolona

Identyfikator operacji:
Workflow_CreateTrigger

Utwórz akcję wyzwalaną po wyzwoleniu reguły w usłudze IoT Central.

Parametry

Nazwa Klucz Wymagane Typ Opis
Aplikacja
 application True string

Unikatowy identyfikator aplikacji.
Identyfikator wyzwalacza przepływu pracy
 id string

Unikatowy identyfikator wyzwalacza przepływu pracy.
Reguła
 rule True string

Unikatowy identyfikator reguły powiązanej z wyzwalaczem przepływu pracy.

Zwraca

Dane wyjściowe tej operacji są dynamiczne.

Definicje

Device

Nazwa Ścieżka Typ Opis
Identyfikator urządzenia
 id string

Unikatowy identyfikator urządzenia.
Nazwa urządzenia
 displayName string

Nazwa wyświetlana urządzenia.
Szablon urządzenia
 instanceOf string

Definicja szablonu urządzenia dla urządzenia.
Symulowany
 simulated boolean

Czy urządzenie jest symulowane.
Zatwierdzony
 approved boolean

Czy urządzenie zostało zatwierdzone do nawiązania połączenia z usługą IoT Central.
Udostępnione
 provisioned boolean

Określa, czy zasoby zostały przydzielone dla urządzenia.

DeviceV1

Nazwa Ścieżka Typ Opis
Identyfikator urządzenia
 id string

Unikatowy identyfikator urządzenia.
Nazwa urządzenia
 displayName string

Nazwa wyświetlana urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.
Symulowany
 simulated boolean

Czy urządzenie jest symulowane.
Włączona
 enabled boolean

Czy połączenie urządzenia z usługą IoT Central zostało włączone.
Udostępnione
 provisioned boolean

Określa, czy zasoby zostały przydzielone dla urządzenia.

DeviceV2

Nazwa Ścieżka Typ Opis
Identyfikator urządzenia
 id string

Unikatowy identyfikator urządzenia.
Nazwa urządzenia
 displayName string

Nazwa wyświetlana urządzenia.
Szablon urządzenia
 template string

Definicja szablonu urządzenia dla urządzenia.
Symulowany
 simulated boolean

Czy urządzenie jest symulowane.
Włączona
 enabled boolean

Czy połączenie urządzenia z usługą IoT Central zostało włączone.
Organizations
 organizations array of string

Lista organizacji urządzenia, tylko jedna organizacja jest obecnie obsługiwana, wiele organizacji będzie obsługiwanych wkrótce.
Udostępnione
 provisioned boolean

Określa, czy zasoby zostały przydzielone dla urządzenia.

DeviceCollectionV1

Nazwa Ścieżka Typ Opis
value
 value array of DeviceV1

Kolekcja urządzeń.
nextLink
 nextLink string

Adres URL umożliwiający pobranie następnej strony urządzeń.

Grupa urządzeń

Definicja grupy urządzeń.

Nazwa Ścieżka Typ Opis
Identyfikator grupy urządzeń
 id string

Unikatowy identyfikator grupy urządzeń.
Wyświetlana nazwa
 displayName string

Nazwa wyświetlana grupy urządzeń.
Filter
 filter string

Zapytanie definiujące, które urządzenia powinny znajdować się w tej grupie.
Description
 description string

Krótkie podsumowanie grupy urządzeń.
ETag
 etag string

Element ETag używany do zapobiegania konfliktom w aktualizacjach grup urządzeń.
Organizations
 organizations array of string

Lista organizacji grupy urządzeń, tylko jedna organizacja jest obecnie obsługiwana, wiele organizacji będzie obsługiwanych wkrótce.

DeviceGroupCollection

Stronicowane wyniki grup urządzeń.

Nazwa Ścieżka Typ Opis
Identyfikator grupy urządzeń
 value array of DeviceGroup

Kolekcja grup urządzeń.
nextLink
 nextLink string

Adres URL umożliwiający pobranie następnej strony grup urządzeń.

DeviceGroupDeviceCollection

Stronicowane wyniki urządzeń należących do grupy urządzeń.

Nazwa Ścieżka Typ Opis
value
 value array of DeviceV1

Kolekcja urządzeń należących do grupy urządzeń.
nextLink
 nextLink string

Adres URL umożliwiający pobranie następnej strony urządzeń w grupie.

DeviceRelationshipStatic

Nazwa Ścieżka Typ Opis
Identyfikator relacji urządzenia
 id string

Unikatowy identyfikator relacji urządzenia.
Identyfikator źródła relacji urządzenia
 source string

Identyfikator urządzenia źródłowego (nadrzędnego).
Identyfikator docelowy relacji urządzenia
 target string

Identyfikator urządzenia źródłowego (podrzędnego).

DeviceRelationshipCollection

Nazwa Ścieżka Typ Opis
value
 value array of DeviceRelationshipStatic

Kolekcja relacji urządzeń.
nextLink
 nextLink string

Adres URL umożliwiający uzyskanie następnej strony relacji urządzeń.

DeviceTemplateV1

Nazwa Ścieżka Typ Opis
Identyfikator szablonu urządzenia
 @id string

Unikatowy identyfikator szablonu urządzenia.
Typy szablonów urządzeń
 @type array of string

Typy JSON-LD tego szablonu urządzenia.
Nazwa szablonu urządzenia
 displayName string

Nazwa wyświetlana szablonu urządzenia.
Opis szablonu urządzenia
 description string

Szczegółowy opis szablonu urządzenia.
Model możliwości szablonu urządzenia
 capabilityModel

Model możliwości używany przez ten szablon urządzenia.

DeviceTemplateCollectionV1

Nazwa Ścieżka Typ Opis
value
 value array of DeviceTemplateV1

Kolekcja szablonów urządzeń.
nextLink
 nextLink string

Adres URL umożliwiający pobranie następnej strony szablonów urządzeń.

JobDeviceStatus

Definicja stanu urządzenia zadania.

Nazwa Ścieżka Typ Opis
Identyfikator urządzenia
 id string

Identyfikator urządzenia, którego stan zadania jest udostępniany.
Stan urządzenia
 status string

Wskazuje, czy zadanie jest uruchamiane, uruchomione itp. dla danego urządzenia.

JobDeviceStatusCollection

Stronicowane wyniki stanu urządzenia zadania.

Nazwa Ścieżka Typ Opis
value
 value array of JobDeviceStatus

Kolekcja stanu urządzenia zadania.
nextLink
 nextLink string

Adres URL umożliwiający pobranie następnej strony stanu urządzenia zadania.

ZadanieBatch

Definicja partii zadań.

Nazwa Ścieżka Typ Opis
Typ partii
 type string

Określa, czy przetwarzanie wsadowe odbywa się na określonej liczbie urządzeń, czy procent całkowitej liczby urządzeń.
Wartość wsadowa
 value number

Liczba lub procent urządzeń, na których odbywa się przetwarzanie wsadowe.

JobCancellationThreshold

Definicja progu anulowania zadania.

Nazwa Ścieżka Typ Opis
Typ progu anulowania
 type string

Określa, czy próg anulowania przypada na określoną liczbę urządzeń, czy wartość procentową całkowitej liczby urządzeń.
Wartość progu anulowania
 value number

Liczba lub procent urządzeń, na których jest stosowany próg anulowania.
Partia progu anulowania
 batch boolean

Niezależnie od tego, czy próg anulowania ma zastosowanie do partii, czy do ogólnego zadania.

Zadaniestatyczne

Definicja zadania.

Nazwa Ścieżka Typ Opis
Identyfikator zadania
 id string

Unikatowy identyfikator zadania.
Wyświetlana nazwa
 displayName string

Nazwa wyświetlana zadania.
Description
 description string

Szczegółowy opis zadania.
Grupa urządzeń
 group string

Identyfikator grupy urządzeń, na której ma zostać wykonane zadanie.
partia
 batch JobBatch

Definicja partii zadań.
cancellationThreshold
 cancellationThreshold JobCancellationThreshold

Definicja progu anulowania zadania.
Dane
 data array of object

Dane związane z operacją wykonywaną przez to zadanie. Wszystkie wpisy muszą być tego samego typu.
items
 data object
Organizations
 organizations array of string

Lista organizacji zadania, tylko jedna organizacja jest obecnie obsługiwana, wiele organizacji będzie obsługiwanych wkrótce.
Identyfikator zaplanowanego zadania
 scheduledJobId string

Identyfikator definicji zaplanowanego zadania, która utworzyła to zadanie.

JobCollection

Stronicowane wyniki zadań.

Nazwa Ścieżka Typ Opis
value
 value array of JobStatic

Kolekcja zadań.
nextLink
 nextLink string

Adres URL umożliwiający pobranie następnej strony zadań.

Organization

Nazwa Ścieżka Typ Opis
Identyfikator organizacji
 id string

Unikatowy identyfikator organizacji.
Nazwa organizacji
 displayName string

Nazwa wyświetlana organizacji.
Parent
 parent string

Nazwa wyświetlana organizacji nadrzędnej.

OrganizacjaCollection

Nazwa Ścieżka Typ Opis
value
 value array of Organization

Kolekcja organizacji.
nextLink
 nextLink string

Adres URL umożliwiający uzyskanie następnej strony organizacji.

RoleV1

Nazwa Ścieżka Typ Opis
id
 id string

Unikatowy identyfikator roli.
nazwa wyświetlana
 displayName string

Nazwa wyświetlana roli.

RoleCollectionV1

Nazwa Ścieżka Typ Opis
value
 value array of RoleV1

Kolekcja ról.

ScheduledJobStatic

Definicja zaplanowanego zadania.

Nazwa Ścieżka Typ Opis
ETag
 etag string

Element ETag używany do zapobiegania konfliktom w zaplanowanych aktualizacjach zadań.
Identyfikator zaplanowanego zadania
 id string

Unikatowy identyfikator zaplanowanego zadania.
Wyświetlana nazwa
 displayName string

Nazwa wyświetlana zaplanowanego zadania.
Description
 description string

Szczegółowy opis zaplanowanego zadania.
Grupa urządzeń
 group string

Identyfikator grupy urządzeń, na której ma zostać wykonane zadanie.
partia
 batch JobBatch

Definicja partii zadań.
cancellationThreshold
 cancellationThreshold JobCancellationThreshold

Definicja progu anulowania zadania.
Dane
 data array of object

Dane związane z operacją wykonywaną przez to zadanie. Wszystkie wpisy muszą być tego samego typu.
items
 data object
Organizations
 organizations array of string

Lista organizacji zadania, tylko jedna organizacja jest obecnie obsługiwana, wiele organizacji będzie obsługiwanych wkrótce.
Schedule
 schedule object

Harmonogram wykonywania zadania.
Włączona
 enabled boolean

Czy zaplanowane zadanie jest włączone.
Zakończone
 completed boolean

Czy zaplanowane zadanie zostało ukończone.

ScheduledJobJobCollection

Stronicowane wyniki definicji zadań należących do zaplanowanego zadania.

Nazwa Ścieżka Typ Opis
value
 value array of JobStatic

Kolekcja zadań.
nextLink
 nextLink string

Adres URL umożliwiający pobranie następnej strony zadań.

UserStaticV1

Nazwa Ścieżka Typ Opis
Identyfikator użytkownika
 id string

Unikatowy identyfikator użytkownika.
Typ użytkownika
 type string

Typ użytkownika.
Role
 roles array of RoleAssignmentV1

Lista przypisań ról określających uprawnienia dostępu do aplikacji.

UserCollectionV1

Nazwa Ścieżka Typ Opis
Użytkownicy
 value array of UserStaticV1

Kolekcja użytkowników.

RoleAssignmentV1

Nazwa Ścieżka Typ Opis
Role
 role string

Identyfikator roli dla tego przypisania roli.