Azure IoT Central V3 (versão prévia)

O Azure IoT Central facilita a conexão, o monitoramento e o gerenciamento de seus dispositivos IoT em escala. Com o conector do IoT Central V3, você pode disparar fluxos de trabalho quando uma regra é acionada e executar ações executando comandos, atualizando propriedades, obtendo telemetria de dispositivos e muito mais. Use esse conector com seu aplicativo do Azure IoT Central V3.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Suporte técnico do Azure IoT Central
URL	https://aka.ms/iotcentral-create-technical-support-ticket-trial

Metadados do conector
Publicador	Microsoft Corporation
Site	https://azure.microsoft.com/services/iot-central/
Política de privacidade	https://privacy.microsoft.com
Categorias	Internet das Coisas

O conector do Azure IoT Central V3 pode ser usado para conectar seu aplicativo Azure IoT Central V3 aos seus fluxos de trabalho. Você pode usar o conector para executar fluxos de trabalho quando uma regra é acionada. Você pode usá-lo para obter as informações mais recentes de seus dispositivos IoT, como dados de telemetria e propriedades. E você também pode usá-lo para atualizar seus dispositivos IoT enviando comandos e atualizando os devidos.

Pré-requisitos

Você deve ser um usuário em um aplicativo pay-as-as-You-Go do Azure IoT Central V3 para usar esse conector.
Você deve usar uma conta corporativa ou de estudante do Microsoft Entra ID.

Como obter credenciais

Para adicionar esse conector ao fluxo de trabalho, primeiro você deve entrar na conta corporativa ou de estudante do Microsoft Entra ID que é um usuário no aplicativo do Azure IoT Central ao qual você deseja se conectar.

Notas de lançamento

Setembro de 2021

O conector do Azure IoT Central V3 foi atualizado para se alinhar à nossa superfície de API REST 1.0 disponível. Todas as ações do conector agora dão suporte ao formato DTDLv2 e o suporte para modelos baseados em DTDLv1 está sendo preterido.
As ações para Run a device command, Get/Update device propertiese Get device telemetry value foram atualizadas para adicionar suporte aos recursos mais recentes do modelo de dispositivo no Azure IoT Central. Essas ações agora dão suporte a recursos raiz e de componente.
Um novo conjunto de ações do módulo de dispositivo foi adicionado. Essas ações permitem a criação de fluxos de trabalho que interagem com Comandos, Propriedades, Telemetrias de módulos de dispositivo e componentes de módulo.
Ações a Get/Create/Update/Delete a device serem atualizadas para se alinharem à API REST mais recente do Azure IoT Central.
As ações Get device cloud properties e Update device cloud properties agora fazem parte de Get device properties e Update device properties. As novas ações permitem que os fluxos de trabalho interajam simultaneamente com propriedades do dispositivo e propriedades de nuvem.

Aviso de substituição: até o final do CY21, as ações marcadas como preteridas na lista abaixo não estarão mais disponíveis ao criar novos fluxos de trabalho. Os fluxos de trabalho existentes que fazem referência a essas ações continuarão funcionando até março de 2022. Recomendamos que você atualize seus fluxos de trabalho para aproveitar as ações recém-anunciadas que agora têm suporte no Azure IoT Central.

Novembro de 2021

Novas ações foram adicionadas para listar dispositivos e modelos de dispositivo para um aplicativo do Azure IoT Central. Essas ações incluem suporte à paginação.
Um novo conjunto de ações de gerenciamento de usuário foi adicionado ao conector, permitindo que os fluxos de trabalho criem, atualizem, listem e excluam usuários de um aplicativo.
Os fluxos de trabalho agora podem obter a execução mais recente de um comando de dispositivo usando as novas Get device command response ações. Esse conjunto de ações dá suporte a comandos raiz, componente e módulo.

Problemas e limitações conhecidos

Para usar esse conector no Microsoft Power Automate, você deve ter entrado no aplicativo do IoT Central pelo menos uma vez. Caso contrário, o aplicativo não aparecerá na lista suspensa aplicativo
Não há suporte para contas pessoais da Microsoft (como @hotmail.comdomínios@live.com@outlook.com, domínios) para entrar no conector do IoT Central. Você deve usar uma conta corporativa ou de estudante do Microsoft Entra ID.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:


Credentials	Credentials	Todas as regiões	Não compartilhável
Padrão [PRETERIDO]	Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores.	Todas as regiões	Não compartilhável

Credentials

ID de autenticação: 1stparty

Aplicável: todas as regiões

Credentials

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Padrão [PRETERIDO]

Aplicável: todas as regiões

Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Atualizar as propriedades do módulo	Atualize todos os valores de propriedade de um módulo.
Atualizar propriedades de nuvem do dispositivo (preterido)	Atualize todos os valores de propriedade de nuvem de um dispositivo por ID do dispositivo (preterido).
Atualizar propriedades do dispositivo	Atualize todos os valores de propriedade de um dispositivo por ID do dispositivo.
Atualizar propriedades do dispositivo (preterido)	Atualize todos os valores de propriedade de um dispositivo por ID do dispositivo (preterido).
Atualizar um trabalho agendado	Atualize um trabalho agendado existente por ID.
Atualizar uma relação de dispositivo	Atualize uma relação de dispositivo existente entre o dispositivo especificado e um novo dispositivo, considerando uma ID do dispositivo e uma ID de relação.
Atualizar usuário	Atualizar um usuário no aplicativo por meio de patch
Criar ou atualizar um dispositivo	Crie um novo dispositivo ou atualize um existente por ID do dispositivo.
Criar ou atualizar um dispositivo (preterido)	Crie um novo dispositivo ou atualize um existente por ID do dispositivo. (preterido)
Criar ou atualizar um dispositivo (preterido)	Crie um novo dispositivo ou atualize um existente por ID do dispositivo (preterido).
Criar um grupo de dispositivos	Criar ou atualizar um grupo de dispositivos.
Criar um grupo de dispositivos	Obtenha detalhes sobre um grupo de dispositivos existente por ID.
Criar um trabalho	Crie e execute um novo trabalho por meio de sua definição de trabalho.
Criar um trabalho agendado	Crie e execute um novo trabalho agendado por meio de sua definição de trabalho.
Criar uma organização	Criar uma nova organização
Criar uma relação de dispositivo	Crie uma nova relação de dispositivo entre o dispositivo especificado e um novo dispositivo, considerando uma ID do dispositivo e uma ID de relação.
Criar usuário	Criar um usuário no aplicativo
Excluir grupo de dispositivos	Excluir um grupo de dispositivos existente por ID
Excluir organização	Excluir uma organização existente por ID
Excluir um dispositivo	Exclua um dispositivo existente por ID do dispositivo.
Excluir um dispositivo (preterido)	Exclua um dispositivo existente por ID do dispositivo (preterido).
excluir um modelo de dispositivo;	Exclua um modelo de dispositivo existente por ID.
Excluir um trabalho agendado	Exclua um trabalho agendado existente por ID.
Excluir uma relação de dispositivo	Exclua uma relação de dispositivo existente por ID do dispositivo e ID de relação.
Excluir usuário	Excluir um usuário
Executar um comando de componente	Execute um comando em um componente.
Executar um comando de componente de módulo	Execute um comando em um componente de módulo.
Executar um comando de dispositivo	Execute um comando em um dispositivo.
Executar um comando de dispositivo (preterido)	Execute um comando em um dispositivo (preterido).
Executar um comando de módulo	Execute um comando em um módulo.
Listar dispositivos	Obtenha a lista de dispositivos em um aplicativo.
Listar funções	Obtenha a lista de funções em um aplicativo.
Listar grupos de dispositivos	Obtenha a lista de grupos de dispositivos em um aplicativo.
Listar modelos de dispositivo	Obtenha a lista de modelos de dispositivo em um aplicativo.
Listar organizações	Obtenha a lista de organizações em um aplicativo.
Listar relações	Listar todas as relações com base na ID do dispositivo.
Listar trabalhos	Obtenha a lista de trabalhos em um aplicativo.
Listar trabalhos agendados	Obtenha a lista de trabalhos agendados em um aplicativo.
Listar usuários	Obter a lista de usuários em um aplicativo
Obter dispositivos por ID do grupo de dispositivos	Obtenha a lista de dispositivos em um grupo de dispositivos em um aplicativo.
Obter função	Obtenha uma função por ID.
Obter o valor da telemetria do componente	Obtenha o último valor de telemetria de um componente.
Obter o valor da telemetria do componente do módulo	Obtenha o último valor de telemetria de um componente de módulo.
Obter o valor de telemetria do dispositivo	Obtenha o último valor de telemetria de um dispositivo.
Obter o valor de telemetria do dispositivo (preterido)	Obtenha o último valor de telemetria de um dispositivo (preterido).
Obter o valor de telemetria do módulo	Obtenha o último valor de telemetria de um módulo.
Obter propriedades de nuvem do dispositivo (preterido)	Obtenha todos os valores de propriedade de nuvem de um dispositivo por ID do dispositivo (preterido).
Obter propriedades do dispositivo	Obtenha todos os valores de propriedade de um dispositivo por ID do dispositivo.
Obter propriedades do dispositivo (preterido)	Obter todos os valores de propriedade de um dispositivo por ID do dispositivo (preterido).
Obter propriedades do módulo	Obter todos os valores de propriedade de um módulo.
Obter relação de dispositivo	Obtenha detalhes sobre uma relação de dispositivo existente por ID do dispositivo e por ID de relação.
Obter resposta de comando do componente	Obtenha a última resposta para um comando de componente do dispositivo.
Obter resposta de comando do componente do módulo	Obtenha a última resposta para um comando de componente do módulo.
Obter resposta de comando do dispositivo	Obtenha a última resposta para um comando de dispositivo.
Obter resposta de comando do módulo	Obter a última resposta para um comando de módulo de dispositivo
Obter status do dispositivo	Obtenha a lista de status de dispositivo individual por ID do trabalho.
Obter trabalhos por ID de trabalho agendada	Obtenha a lista de trabalhos para uma definição de trabalho agendada.
Obter um dispositivo por ID	Obtenha detalhes sobre um dispositivo existente por ID do dispositivo.
Obter um dispositivo por ID (preterido)	Obtenha detalhes sobre um dispositivo existente por ID do dispositivo (preterido).
obter um modelo de dispositivo por ID;	Obtenha detalhes sobre um modelo de dispositivo existente por ID.
Obter um trabalho	Obtenha detalhes sobre um trabalho existente por ID.
Obter um trabalho agendado	Obtenha detalhes sobre um trabalho agendado existente por ID.
Obter uma organização	Obtenha detalhes sobre uma organização existente por ID.
Obter usuário	Obter um usuário por ID
Parar um trabalho em execução	Interrompa a execução de um trabalho que está em execução no momento.
Retomar um trabalho em dispositivos com falha	Execute uma nova execução de um trabalho existente em todos os dispositivos com falha.
Retomar um trabalho interrompido	Retomar a execução de um trabalho parado existente.

Atualizar as propriedades do módulo

ID da operação:: Devices_UpdateModuleProperties_V1

Atualize todos os valores de propriedade de um módulo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Módulo do dispositivo	module	True	string	Nome do módulo do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Propriedades do dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Atualizar propriedades de nuvem do dispositivo (preterido)

ID da operação:: Devices_UpdateCloudProperties

Atualize todos os valores de propriedade de nuvem de um dispositivo por ID do dispositivo (preterido).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
ID do modelo de dispositivo	instanceOf		string	A definição do modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Propriedades do dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Atualizar propriedades do dispositivo

ID da operação:: Devices_UpdateProperties_V1

Atualize todos os valores de propriedade de um dispositivo por ID do dispositivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Propriedades do dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Atualizar propriedades do dispositivo (preterido)

ID da operação:: Devices_UpdateProperties

Atualize todos os valores de propriedade de um dispositivo por ID do dispositivo (preterido).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
ID do modelo de dispositivo	instanceOf		string	A definição do modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Propriedades do dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Atualizar um trabalho agendado

ID da operação:: ScheduledJobs_Update

Atualize um trabalho agendado existente por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do trabalho agendada	scheduled_job_id	True	string	ID exclusiva do trabalho agendado.
Tipo de Término de Agendamento	scheduled_job_end_type		string	Como o trabalho agendado deve terminar (não aplicado às migrações de modelo de dispositivo).
Corpo	body	True	dynamic	Corpo de criação de trabalho agendado.

Retornos

A definição de trabalho agendada.

Corpo: ScheduledJobStatic

Atualizar uma relação de dispositivo

ID da operação:: DeviceRelationships_Update

Atualize uma relação de dispositivo existente entre o dispositivo especificado e um novo dispositivo, considerando uma ID do dispositivo e uma ID de relação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
ID da relação	relationship_id	True	string	ID exclusiva da relação do dispositivo.
ID da relação do dispositivo	id		string	ID exclusiva da relação do dispositivo.
ID de destino da relação do dispositivo	target	True	string	A ID do dispositivo de origem (filho).

Retornos

Corpo: DeviceRelationshipStatic

Atualizar usuário

ID da operação:: Users_Update_V1

Atualizar um usuário no aplicativo por meio de patch

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
Utilizador	user_id	True	string	ID exclusiva do usuário.
Tipo de usuário	user_type		string	Tipo do usuário.
Corpo	body	True	dynamic	Corpo da atualização do usuário.

Retornos

As saídas desta operação são dinâmicas.

Criar ou atualizar um dispositivo

ID da operação:: Devices_Set_V2

Crie um novo dispositivo ou atualize um existente por ID do dispositivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
ID do dispositivo	id		string	ID exclusiva do dispositivo.
Nome do dispositivo	displayName		string	Nome de exibição do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.
Simulado	simulated		boolean	Se o dispositivo é simulado.
Enabled	enabled		boolean	Se a conexão do dispositivo com o IoT Central foi habilitada.
Organizations	organizations		array of string	Lista de organizações do dispositivo, apenas uma organização tem suporte hoje, várias organizações terão suporte em breve.
Provisionado	provisioned		boolean	Se os recursos foram alocados para o dispositivo.

Retornos

Corpo: DeviceV2

Criar ou atualizar um dispositivo (preterido)

ID da operação:: Devices_Set_V1

Crie um novo dispositivo ou atualize um existente por ID do dispositivo. (preterido)

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
ID do dispositivo	id		string	ID exclusiva do dispositivo.
Nome do dispositivo	displayName		string	Nome de exibição do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.
Simulado	simulated		boolean	Se o dispositivo é simulado.
Enabled	enabled		boolean	Se a conexão do dispositivo com o IoT Central foi habilitada.
Provisionado	provisioned		boolean	Se os recursos foram alocados para o dispositivo.

Retornos

Corpo: DeviceV1

Criar ou atualizar um dispositivo (preterido)

ID da operação:: Devices_Set

Crie um novo dispositivo ou atualize um existente por ID do dispositivo (preterido).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
ID do dispositivo	id		string	ID exclusiva do dispositivo.
Nome do dispositivo	displayName		string	Nome de exibição do dispositivo.
Modelo de dispositivo	instanceOf		string	A definição do modelo de dispositivo para o dispositivo.
Simulado	simulated		boolean	Se o dispositivo é simulado.
Aprovada	approved		boolean	Se o dispositivo foi aprovado para se conectar ao IoT Central.
Provisionado	provisioned		boolean	Se os recursos foram alocados para o dispositivo.

Retornos

Corpo: Device

Criar um grupo de dispositivos

ID da operação:: DeviceGroups_Set

Criar ou atualizar um grupo de dispositivos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do grupo de dispositivos	device_group_id	True	string	ID exclusiva do grupo de dispositivos.
ID do grupo de dispositivos	id		string	ID exclusiva do grupo de dispositivos.
Nome de Exibição	displayName	True	string	Nome de exibição do grupo de dispositivos.
Filter	filter	True	string	Consulta definindo quais dispositivos devem estar nesse grupo.
Description	description		string	Resumo curto do grupo de dispositivos.
Etag	etag		string	ETag usada para evitar conflitos em atualizações de grupo de dispositivos.
Organizations	organizations		array of string	Lista de organizações do grupo de dispositivos, apenas uma organização tem suporte hoje, várias organizações terão suporte em breve.

Retornos

A definição do grupo de dispositivos.

Corpo: DeviceGroup

Criar um grupo de dispositivos

ID da operação:: DeviceGroups_Get

Obtenha detalhes sobre um grupo de dispositivos existente por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do grupo de dispositivos	device_group_id	True	string	ID exclusiva do grupo de dispositivos.

Retornos

A definição do grupo de dispositivos.

Corpo: DeviceGroup

Criar um trabalho

ID da operação:: Jobs_Set

Crie e execute um novo trabalho por meio de sua definição de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do trabalho	job_id	True	string	ID exclusiva do trabalho.
Tipo de trabalho	job_type		string	Tipo do trabalho.
Corpo	body	True	dynamic	Corpo de criação de trabalho.

Retornos

As saídas desta operação são dinâmicas.

Criar um trabalho agendado

ID da operação:: ScheduledJobs_Set

Crie e execute um novo trabalho agendado por meio de sua definição de trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do trabalho agendada	scheduled_job_id	True	string	ID exclusiva do trabalho agendado.
Tipo de trabalho	job_type		string	Tipo do trabalho.
Tipo de Término de Agendamento	scheduled_job_end_type		string	Como o trabalho agendado deve terminar (não aplicado às migrações de modelo de dispositivo).
Corpo	body	True	dynamic	Corpo de criação de trabalho agendado.

Retornos

As saídas desta operação são dinâmicas.

Criar uma organização

ID da operação:: Organizations_Set

Criar uma nova organização

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID da Organização	organization_id	True	string	ID exclusiva da organização.
ID da Organização	id		string	ID exclusiva da organização.
Nome da Organização	displayName		string	Nome de exibição da organização.
Parent	parent		string	Nome de exibição da organização pai.

Retornos

Corpo: Organization

Criar uma relação de dispositivo

ID da operação:: DeviceRelationships_Set

Crie uma nova relação de dispositivo entre o dispositivo especificado e um novo dispositivo, considerando uma ID do dispositivo e uma ID de relação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID da relação	relationship_id	True	string	ID exclusiva da relação do dispositivo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
ID da relação do dispositivo	id		string	ID exclusiva da relação do dispositivo.
ID de destino da relação do dispositivo	target	True	string	A ID do dispositivo de origem (filho).

Retornos

Corpo: DeviceRelationshipStatic

Criar usuário

ID da operação:: Users_Create_V1

Criar um usuário no aplicativo

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
Utilizador	user_id	True	string	ID exclusiva do usuário.
Tipo de usuário	user_type		string	Tipo do usuário.
Corpo	body	True	dynamic	Corpo de criação do usuário.

Retornos

As saídas desta operação são dinâmicas.

Excluir grupo de dispositivos

ID da operação:: DeviceGroups_Remove

Excluir um grupo de dispositivos existente por ID

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do grupo de dispositivos	device_group_id	True	string	ID exclusiva do grupo de dispositivos.

Excluir organização

ID da operação:: Organizations_Remove

Excluir uma organização existente por ID

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID da Organização	organization_id	True	string	ID exclusiva da organização.

Excluir um dispositivo

ID da operação:: Devices_Remove_V1

Exclua um dispositivo existente por ID do dispositivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.

Excluir um dispositivo (preterido)

ID da operação:: Devices_Remove

Exclua um dispositivo existente por ID do dispositivo (preterido).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.

excluir um modelo de dispositivo;

ID da operação:: DeviceTemplates_Remove_V1

Exclua um modelo de dispositivo existente por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
Template	template_id	True	string	ID exclusiva do modelo.

Excluir um trabalho agendado

ID da operação:: ScheduledJobs_Remove

Exclua um trabalho agendado existente por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do trabalho agendada	scheduled_job_id	True	string	ID exclusiva do trabalho agendado.

Excluir uma relação de dispositivo

ID da operação:: DeviceRelationships_Remove

Exclua uma relação de dispositivo existente por ID do dispositivo e ID de relação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
ID da relação	relationship_id	True	string	ID exclusiva da relação do dispositivo.

Excluir usuário

ID da operação:: Users_Remove_V1

Excluir um usuário

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
Utilizador	user_id	True	string	ID exclusiva do usuário.

Executar um comando de componente

ID da operação:: Devices_RunComponentCommand_V1

Execute um comando em um componente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Componente do dispositivo	component_name	True	string	Nome do componente do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Corpo do comando do dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Executar um comando de componente de módulo

ID da operação:: Devices_RunModuleComponentCommand_V1

Execute um comando em um componente de módulo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Módulo do dispositivo	module	True	string	Nome do módulo do dispositivo.
Componente do dispositivo	component_name	True	string	Nome do componente do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Corpo do comando do dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Executar um comando de dispositivo

ID da operação:: Devices_RunCommand_V1

Execute um comando em um dispositivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Corpo do comando do dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Executar um comando de dispositivo (preterido)

ID da operação:: Devices_ExecuteComponentCommand

Execute um comando em um dispositivo (preterido).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Componente do dispositivo	component_name	True	string	Nome do componente do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando do dispositivo.
ID do modelo de dispositivo	instanceOf		string	A definição do modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Corpo do comando do dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Executar um comando de módulo

ID da operação:: Devices_RunModuleCommand_V1

Execute um comando em um módulo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Módulo do dispositivo	module	True	string	Nome do módulo do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Corpo do comando do dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Listar dispositivos

ID da operação:: Devices_List_V1

Obtenha a lista de dispositivos em um aplicativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.

Retornos

Corpo: DeviceCollectionV1

Listar funções

ID da operação:: Roles_List_V1

Obtenha a lista de funções em um aplicativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.

Retornos

Corpo: RoleCollectionV1

Listar grupos de dispositivos

ID da operação:: DeviceGroups_List

Obtenha a lista de grupos de dispositivos em um aplicativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.

Retornos

Os resultados de páginas de grupos de dispositivos.

Corpo: DeviceGroupCollection

Listar modelos de dispositivo

ID da operação:: DeviceTemplates_List_V1

Obtenha a lista de modelos de dispositivo em um aplicativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.

Retornos

Corpo: DeviceTemplateCollectionV1

Listar organizações

ID da operação:: Organizations_List

Obtenha a lista de organizações em um aplicativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.

Retornos

Corpo: OrganizationCollection

Listar relações

ID da operação:: DeviceRelationships_List

Listar todas as relações com base na ID do dispositivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.

Retornos

Corpo: DeviceRelationshipCollection

Listar trabalhos

ID da operação:: Jobs_List

Obtenha a lista de trabalhos em um aplicativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.

Retornos

Os resultados de trabalhos paginado.

Corpo: JobCollection

Listar trabalhos agendados

ID da operação:: ScheduledJobs_List

Obtenha a lista de trabalhos agendados em um aplicativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.

Retornos

As saídas desta operação são dinâmicas.

Listar usuários

ID da operação:: Users_List_V1

Obter a lista de usuários em um aplicativo

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.

Retornos

Corpo: UserCollectionV1

Obter dispositivos por ID do grupo de dispositivos

ID da operação:: DeviceGroups_GetDevices

Obtenha a lista de dispositivos em um grupo de dispositivos em um aplicativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do grupo de dispositivos	device_group_id	True	string	ID exclusiva do grupo de dispositivos.

Retornos

Os resultados paginado de dispositivos pertencentes ao grupo de dispositivos.

Corpo: DeviceGroupDeviceCollection

Obter função

ID da operação:: Roles_Get_V1

Obtenha uma função por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
Função	role_id	True	string	ID exclusiva para a função.

Retornos

Corpo: RoleV1

Obter o valor da telemetria do componente

ID da operação:: Devices_GetComponentTelemetryValue_V1

Obtenha o último valor de telemetria de um componente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Componente do dispositivo	component_name	True	string	Nome do componente do dispositivo.
Telemetria do dispositivo	telemetry_name	True	string	Nome dessa telemetria do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Obter o valor da telemetria do componente do módulo

ID da operação:: Devices_GetModuleComponentTelemetryValue_V1

Obtenha o último valor de telemetria de um componente de módulo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Módulo do dispositivo	module	True	string	Nome do módulo do dispositivo.
Componente do dispositivo	component_name	True	string	Nome do componente do dispositivo.
Telemetria do dispositivo	telemetry_name	True	string	Nome dessa telemetria do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Obter o valor de telemetria do dispositivo

ID da operação:: Devices_GetTelemetryValue_V1

Obtenha o último valor de telemetria de um dispositivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Telemetria do dispositivo	telemetry_name	True	string	Nome dessa telemetria do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Obter o valor de telemetria do dispositivo (preterido)

ID da operação:: Devices_GetComponentTelemetryValue

Obtenha o último valor de telemetria de um dispositivo (preterido).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Componente do dispositivo	component_name	True	string	Nome do componente do dispositivo.
Telemetria do dispositivo	telemetry_name	True	string	Nome dessa telemetria do dispositivo.
ID do modelo de dispositivo	instanceOf		string	A definição do modelo de dispositivo para o dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Obter o valor de telemetria do módulo

ID da operação:: Devices_GetModuleTelemetryValue_V1

Obtenha o último valor de telemetria de um módulo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Módulo do dispositivo	module	True	string	Nome do módulo do dispositivo.
Telemetria do dispositivo	telemetry_name	True	string	Nome dessa telemetria do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Obter propriedades de nuvem do dispositivo (preterido)

ID da operação:: Devices_GetCloudProperties

Obtenha todos os valores de propriedade de nuvem de um dispositivo por ID do dispositivo (preterido).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
ID do modelo de dispositivo	instanceOf		string	A definição do modelo de dispositivo para o dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Obter propriedades do dispositivo

ID da operação:: Devices_GetProperties_V1

Obtenha todos os valores de propriedade de um dispositivo por ID do dispositivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Obter propriedades do dispositivo (preterido)

ID da operação:: Devices_GetProperties

Obter todos os valores de propriedade de um dispositivo por ID do dispositivo (preterido).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
ID do modelo de dispositivo	instanceOf		string	A definição do modelo de dispositivo para o dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Obter propriedades do módulo

ID da operação:: Devices_GetModuleProperties_V1

Obter todos os valores de propriedade de um módulo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Módulo do dispositivo	module	True	string	Nome do módulo do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Obter relação de dispositivo

ID da operação:: DeviceRelationships_Get

Obtenha detalhes sobre uma relação de dispositivo existente por ID do dispositivo e por ID de relação.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
ID da relação	relationship_id	True	string	ID exclusiva da relação do dispositivo.

Retornos

Corpo: DeviceRelationshipStatic

Obter resposta de comando do componente

ID da operação:: Devices_GetComponentCommandResponse_V1

Obtenha a última resposta para um comando de componente do dispositivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Componente do dispositivo	component_name	True	string	Nome do componente do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Obter resposta de comando do componente do módulo

ID da operação:: Devices_GetModuleComponentCommandResponse_V1

Obtenha a última resposta para um comando de componente do módulo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Módulo do dispositivo	module	True	string	Nome do módulo do dispositivo.
Componente do dispositivo	component_name	True	string	Nome do componente do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Obter resposta de comando do dispositivo

ID da operação:: Devices_GetCommandResponse_V1

Obtenha a última resposta para um comando de dispositivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Obter resposta de comando do módulo

ID da operação:: Devices_GetModuleCommandResponse_V1

Obter a última resposta para um comando de módulo de dispositivo

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.
Módulo do dispositivo	module	True	string	Nome do módulo do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando do dispositivo.
Modelo de dispositivo	template		string	A definição do modelo de dispositivo para o dispositivo.

Retornos

As saídas desta operação são dinâmicas.

Obter status do dispositivo

ID da operação:: Jobs_GetDevices

Obtenha a lista de status de dispositivo individual por ID do trabalho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do trabalho	job_id	True	string	ID exclusiva do trabalho.

Retornos

Os resultados paginado dos status do dispositivo de trabalho.

Corpo: JobDeviceStatusCollection

Obter trabalhos por ID de trabalho agendada

ID da operação:: ScheduledJobs_ListJobs

Obtenha a lista de trabalhos para uma definição de trabalho agendada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do trabalho agendada	scheduled_job_id	True	string	ID exclusiva do trabalho agendado.

Retornos

Os resultados de páginas de definições de trabalho pertencentes a um trabalho agendado.

Corpo: ScheduledJobJobCollection

Obter um dispositivo por ID

ID da operação:: Devices_Get_V1

Obtenha detalhes sobre um dispositivo existente por ID do dispositivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.

Retornos

Corpo: DeviceV1

Obter um dispositivo por ID (preterido)

ID da operação:: Devices_Get

Obtenha detalhes sobre um dispositivo existente por ID do dispositivo (preterido).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusiva do dispositivo.

Retornos

Corpo: Device

obter um modelo de dispositivo por ID;

ID da operação:: DeviceTemplates_Get_V1

Obtenha detalhes sobre um modelo de dispositivo existente por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
Template	template_id	True	string	ID exclusiva do modelo.

Retornos

Corpo: DeviceTemplateV1

Obter um trabalho

ID da operação:: Jobs_Get

Obtenha detalhes sobre um trabalho existente por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do trabalho	job_id	True	string	ID exclusiva do trabalho.

Retornos

A definição do trabalho.

Corpo: JobStatic

Obter um trabalho agendado

ID da operação:: ScheduledJobs_Get

Obtenha detalhes sobre um trabalho agendado existente por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do trabalho agendada	scheduled_job_id	True	string	ID exclusiva do trabalho agendado.

Retornos

As saídas desta operação são dinâmicas.

Obter uma organização

ID da operação:: Organizations_Get

Obtenha detalhes sobre uma organização existente por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID da Organização	organization_id	True	string	ID exclusiva da organização.

Retornos

Corpo: Organization

Obter usuário

ID da operação:: Users_Get_V1

Obter um usuário por ID

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
Utilizador	user_id	True	string	ID exclusiva do usuário.

Retornos

Corpo: UserStaticV1

Parar um trabalho em execução

ID da operação:: Jobs_Stop

Interrompa a execução de um trabalho que está em execução no momento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do trabalho	job_id	True	string	ID exclusiva do trabalho.

Retomar um trabalho em dispositivos com falha

ID da operação:: Jobs_Rerun

Execute uma nova execução de um trabalho existente em todos os dispositivos com falha.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do trabalho	job_id	True	string	ID exclusiva do trabalho.
Executar novamente a ID	rerun_id	True	string	ID exclusiva da nova execução.

Retornos

A definição do trabalho.

Corpo: JobStatic

Retomar um trabalho interrompido

ID da operação:: Jobs_Resume

Retomar a execução de um trabalho parado existente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do trabalho	job_id	True	string	ID exclusiva do trabalho.

Gatilhos

Quando uma regra é acionada

Crie uma ação que é disparada quando uma regra é acionada no IoT Central.

Quando uma regra é acionada

ID da operação:: Workflow_CreateTrigger

Crie uma ação que é disparada quando uma regra é acionada no IoT Central.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Aplicativo	application	True	string	ID exclusiva do aplicativo.
ID do gatilho de fluxo de trabalho	id		string	ID exclusiva do gatilho de fluxo de trabalho.
Regra	rule	True	string	ID exclusiva da regra que está vinculada ao gatilho de fluxo de trabalho.

Retornos

As saídas desta operação são dinâmicas.

Definições

Device

Nome	Caminho	Tipo	Description
ID do dispositivo	id	string	ID exclusiva do dispositivo.
Nome do dispositivo	displayName	string	Nome de exibição do dispositivo.
Modelo de dispositivo	instanceOf	string	A definição do modelo de dispositivo para o dispositivo.
Simulado	simulated	boolean	Se o dispositivo é simulado.
Aprovada	approved	boolean	Se o dispositivo foi aprovado para se conectar ao IoT Central.
Provisionado	provisioned	boolean	Se os recursos foram alocados para o dispositivo.

DeviceV1

Nome	Caminho	Tipo	Description
ID do dispositivo	id	string	ID exclusiva do dispositivo.
Nome do dispositivo	displayName	string	Nome de exibição do dispositivo.
Modelo de dispositivo	template	string	A definição do modelo de dispositivo para o dispositivo.
Simulado	simulated	boolean	Se o dispositivo é simulado.
Enabled	enabled	boolean	Se a conexão do dispositivo com o IoT Central foi habilitada.
Provisionado	provisioned	boolean	Se os recursos foram alocados para o dispositivo.

DeviceV2

Nome	Caminho	Tipo	Description
ID do dispositivo	id	string	ID exclusiva do dispositivo.
Nome do dispositivo	displayName	string	Nome de exibição do dispositivo.
Modelo de dispositivo	template	string	A definição do modelo de dispositivo para o dispositivo.
Simulado	simulated	boolean	Se o dispositivo é simulado.
Enabled	enabled	boolean	Se a conexão do dispositivo com o IoT Central foi habilitada.
Organizations	organizations	array of string	Lista de organizações do dispositivo, apenas uma organização tem suporte hoje, várias organizações terão suporte em breve.
Provisionado	provisioned	boolean	Se os recursos foram alocados para o dispositivo.

DeviceCollectionV1

Nome	Caminho	Tipo	Description
value	value	array of DeviceV1	A coleção de dispositivos.
nextLink	nextLink	string	URL para obter a próxima página de dispositivos.

DeviceGroup

A definição do grupo de dispositivos.

Nome	Caminho	Tipo	Description
ID do grupo de dispositivos	id	string	ID exclusiva do grupo de dispositivos.
Nome de Exibição	displayName	string	Nome de exibição do grupo de dispositivos.
Filter	filter	string	Consulta definindo quais dispositivos devem estar nesse grupo.
Description	description	string	Resumo curto do grupo de dispositivos.
Etag	etag	string	ETag usada para evitar conflitos em atualizações de grupo de dispositivos.
Organizations	organizations	array of string	Lista de organizações do grupo de dispositivos, apenas uma organização tem suporte hoje, várias organizações terão suporte em breve.

DeviceGroupCollection

Os resultados de páginas de grupos de dispositivos.

Nome	Caminho	Tipo	Description
ID do grupo de dispositivos	value	array of DeviceGroup	A coleção de grupos de dispositivos.
nextLink	nextLink	string	URL para obter a próxima página de grupos de dispositivos.

DeviceGroupDeviceCollection

Os resultados paginado de dispositivos pertencentes ao grupo de dispositivos.

Nome	Caminho	Tipo	Description
value	value	array of DeviceV1	A coleção de dispositivos que pertencem ao grupo de dispositivos.
nextLink	nextLink	string	URL para obter a próxima página de dispositivos no grupo.

DeviceRelationshipStatic

Nome	Caminho	Tipo	Description
ID da relação do dispositivo	id	string	ID exclusiva da relação do dispositivo.
ID da origem da relação do dispositivo	source	string	A ID do dispositivo de origem (pai).
ID de destino da relação do dispositivo	target	string	A ID do dispositivo de origem (filho).

DeviceRelationshipCollection

Nome	Caminho	Tipo	Description
value	value	array of DeviceRelationshipStatic	A coleção de relações de dispositivo.
nextLink	nextLink	string	URL para obter a próxima página de relações de dispositivo.

DeviceTemplateV1

Nome	Caminho	Tipo	Description
ID do modelo de dispositivo	@id	string	ID exclusiva do modelo de dispositivo.
Tipos de modelo de dispositivo	@type	array of string	Os tipos JSON-LD deste modelo de dispositivo.
Nome do modelo de dispositivo	displayName	string	Nome de exibição do modelo de dispositivo.
Descrição do modelo de dispositivo	description	string	Descrição detalhada do modelo de dispositivo.
Modelo de funcionalidade do modelo de dispositivo	capabilityModel		O modelo de funcionalidade utilizado por este modelo de dispositivo.

DeviceTemplateCollectionV1

Nome	Caminho	Tipo	Description
value	value	array of DeviceTemplateV1	A coleção de modelos de dispositivo.
nextLink	nextLink	string	URL para obter a próxima página de modelos de dispositivo.

JobDeviceStatus

A definição de status do dispositivo de trabalho.

Nome	Caminho	Tipo	Description
ID do dispositivo	id	string	ID do dispositivo cujo status de trabalho está sendo fornecido.
Status do dispositivo	status	string	Indica se o trabalho está sendo iniciado, em execução etc. para o dispositivo especificado.

JobDeviceStatusCollection

Os resultados paginado dos status do dispositivo de trabalho.

Nome	Caminho	Tipo	Description
value	value	array of JobDeviceStatus	A coleção de status do dispositivo de trabalho.
nextLink	nextLink	string	URL para obter a próxima página de status do dispositivo de trabalho.

JobBatch

A definição do lote de trabalho.

Nome	Caminho	Tipo	Description
Tipo de Lote	type	string	Se o envio em lote é feito em um número especificado de dispositivos ou uma porcentagem do total de dispositivos.
Valor do Lote	value	number	O número ou percentual de dispositivos nos quais o envio em lote é feito.

JobCancellationThreshold

A definição do limite de cancelamento de trabalho.

Nome	Caminho	Tipo	Description
Tipo de limite de cancelamento	type	string	Se o limite de cancelamento é por um número especificado de dispositivos ou uma porcentagem do total de dispositivos.
Valor do limite de cancelamento	value	number	O número ou percentual de dispositivos nos quais o limite de cancelamento é aplicado.
Lote de Limite de Cancelamento	batch	boolean	Se o limite de cancelamento se aplica por lote ou ao trabalho geral.

JobStatic

A definição do trabalho.

Nome	Caminho	Tipo	Description
ID do trabalho	id	string	ID exclusiva do trabalho.
Nome de Exibição	displayName	string	Nome de exibição do trabalho.
Description	description	string	Descrição detalhada do trabalho.
Grupo de Dispositivos	group	string	A ID do grupo de dispositivos no qual executar o trabalho.
lote	batch	JobBatch	A definição do lote de trabalho.
cancellationThreshold	cancellationThreshold	JobCancellationThreshold	A definição do limite de cancelamento de trabalho.
Dados	data	array of object	Dados relacionados à operação que está sendo executada por esse trabalho. Todas as entradas devem ser do mesmo tipo.
items	data	object
Organizations	organizations	array of string	Lista de organizações do trabalho, apenas uma organização tem suporte hoje, várias organizações terão suporte em breve.
ID do trabalho agendada	scheduledJobId	string	ID da definição de trabalho agendada que criou esse trabalho.

JobCollection

Os resultados de trabalhos paginado.

Nome	Caminho	Tipo	Description
value	value	array of JobStatic	A coleção de trabalhos.
nextLink	nextLink	string	URL para obter a próxima página de trabalhos.

Organização

Nome	Caminho	Tipo	Description
ID da Organização	id	string	ID exclusiva da organização.
Nome da Organização	displayName	string	Nome de exibição da organização.
Parent	parent	string	Nome de exibição da organização pai.

OrganizationCollection

Nome	Caminho	Tipo	Description
value	value	array of Organization	A coleção de organizações.
nextLink	nextLink	string	URL para obter a próxima página das organizações.

RoleV1

Nome	Caminho	Tipo	Description
id	id	string	ID exclusiva da função.
nome de exibição	displayName	string	Nome de exibição da função.

RoleCollectionV1

Nome	Caminho	Tipo	Description
value	value	array of RoleV1	A coleção de funções.

ScheduledJobStatic

A definição de trabalho agendada.

Nome	Caminho	Tipo	Description
Etag	etag	string	ETag usada para evitar conflitos em atualizações de trabalho agendadas.
ID do trabalho agendada	id	string	ID exclusiva do trabalho agendado.
Nome de Exibição	displayName	string	Nome de exibição do trabalho agendado.
Description	description	string	Descrição detalhada do trabalho agendado.
Grupo de Dispositivos	group	string	A ID do grupo de dispositivos no qual executar o trabalho.
lote	batch	JobBatch	A definição do lote de trabalho.
cancellationThreshold	cancellationThreshold	JobCancellationThreshold	A definição do limite de cancelamento de trabalho.
Dados	data	array of object	Dados relacionados à operação que está sendo executada por esse trabalho. Todas as entradas devem ser do mesmo tipo.
items	data	object
Organizations	organizations	array of string	Lista de organizações do trabalho, apenas uma organização tem suporte hoje, várias organizações terão suporte em breve.
Cronograma	schedule	object	A agenda na qual executar o trabalho.
Enabled	enabled	boolean	Se o trabalho agendado está habilitado.
Concluído	completed	boolean	Se o trabalho agendado foi concluído.

ScheduledJobJobCollection

Os resultados de páginas de definições de trabalho pertencentes a um trabalho agendado.

Nome	Caminho	Tipo	Description
value	value	array of JobStatic	A coleção de trabalhos.
nextLink	nextLink	string	URL para obter a próxima página de trabalhos.

UserStaticV1

Nome	Caminho	Tipo	Description
ID do Usuário	id	string	ID exclusiva do usuário.
Tipo de usuário	type	string	Tipo do usuário.
Funções	roles	array of RoleAssignmentV1	Lista de atribuições de função que especificam as permissões para acessar o aplicativo.

UserCollectionV1

Nome	Caminho	Tipo	Description
Usuários	value	array of UserStaticV1	A coleção de usuários.

RoleAssignmentV1

Nome	Caminho	Tipo	Description
Função	role	string	ID da função para essa atribuição de função.

Compartilhar via

Azure IoT Central V3 (versão prévia)

Pré-requisitos

Como obter credenciais

Notas de lançamento

Setembro de 2021

Novembro de 2021

Problemas e limitações conhecidos

Criando uma conexão

Credentials

Padrão [PRETERIDO]

Limitações

Ações

Atualizar as propriedades do módulo

Parâmetros

Retornos

Atualizar propriedades de nuvem do dispositivo (preterido)

Parâmetros

Retornos

Atualizar propriedades do dispositivo

Parâmetros

Retornos

Atualizar propriedades do dispositivo (preterido)

Parâmetros

Retornos

Atualizar um trabalho agendado

Parâmetros

Retornos

Atualizar uma relação de dispositivo

Parâmetros

Retornos

Atualizar usuário

Parâmetros

Retornos

Criar ou atualizar um dispositivo

Parâmetros

Retornos

Criar ou atualizar um dispositivo (preterido)

Parâmetros

Retornos

Criar ou atualizar um dispositivo (preterido)

Parâmetros

Retornos

Criar um grupo de dispositivos

Parâmetros

Retornos

Criar um grupo de dispositivos

Parâmetros

Retornos

Criar um trabalho

Parâmetros

Retornos

Criar um trabalho agendado

Parâmetros

Retornos

Criar uma organização

Parâmetros

Retornos

Criar uma relação de dispositivo

Parâmetros

Retornos

Criar usuário

Parâmetros

Retornos

Excluir grupo de dispositivos

Parâmetros

Excluir organização

Parâmetros

Excluir um dispositivo

Parâmetros

Excluir um dispositivo (preterido)

Parâmetros

excluir um modelo de dispositivo;

Parâmetros

Excluir um trabalho agendado

Parâmetros

Excluir uma relação de dispositivo

Parâmetros

Excluir usuário

Parâmetros