Azure IoT Central V3 (Pré-visualização)

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

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

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - 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
Editora	Corporação Microsoft
Sítio Web	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 do 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 properites.

Pré-requisitos

Você deve ser um usuário em um aplicativo do Azure IoT Central V3 Pay-As-You-Go 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 seu fluxo de trabalho, você deve primeiro entrar na conta corporativa ou escolar 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 com a nossa superfície da API REST 1.0 disponível ao público. Todas as ações do conector agora suportam nosso 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 de modelo de dispositivo mais recentes no Azure IoT Central. Essas ações agora suportam recursos raiz e de componentes.
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 dispositivos e componentes de módulos.
Ações a Get/Create/Update/Delete a device serem atualizadas para alinhamento com a 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 com as Propriedades do Dispositivo e as Propriedades da Nuvem simultaneamente.

Aviso de descontinuaçã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 referentes a essas ações continuarão funcionando até março de 2022. Incentivamos você a atualizar seus fluxos de trabalho para aproveitar as ações recém-anunciadas que agora são suportadas 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ários 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. Este conjunto de ações suporta comandos root, component e module.

Problemas conhecidos e limitações

Para usar esse conector no Microsoft Power Automate, você deve ter entrado no aplicativo 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.com, @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.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Credentials	Credentials	Todas as regiões	Não compartilhável
Padrão [DEPRECATED]	Esta 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

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Padrão [DEPRECATED]

Aplicável: Todas as regiões

Esta 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.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Atualizar propriedades da nuvem do dispositivo (preterido)	Atualize todos os valores de propriedade de nuvem de um dispositivo por ID de dispositivo (preterido).
Atualizar propriedades do dispositivo	Atualize todos os valores de propriedade de um dispositivo por ID de dispositivo.
Atualizar propriedades do dispositivo (preterido)	Atualize todos os valores de propriedade de um dispositivo por ID de dispositivo (preterido).
Atualizar propriedades do módulo	Atualize todos os valores de propriedade de um módulo.
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 um determinado dispositivo e um novo dispositivo com um ID de dispositivo e um ID de relacionamento.
Atualizar utilizador	Atualizar um usuário no aplicativo via patch
Conseguir um emprego	Obtenha detalhes sobre um trabalho existente por ID.
Criar ou atualizar um dispositivo	Crie um novo dispositivo ou atualize um existente por ID de dispositivo.
Criar ou atualizar um dispositivo (preterido)	Crie um novo dispositivo ou atualize um existente por ID de dispositivo. (preterido)
Criar ou atualizar um dispositivo (preterido)	Crie um novo dispositivo ou atualize um existente por ID de dispositivo (preterido).
Criar um emprego	Crie e execute um novo trabalho por meio de sua definição de trabalho.
Criar um grupo de dispositivos	Crie ou atualize um grupo de dispositivos.
Criar um trabalho agendado	Crie e execute um novo trabalho agendado por meio de sua definição de trabalho.
Criar uma nova organização	Crie uma nova organização.
Criar uma relação de dispositivo	Crie uma nova relação de dispositivo entre um determinado dispositivo e um novo dispositivo com um ID de dispositivo e um ID de relacionamento.
Criar utilizador	Criar um usuário no aplicativo
Eliminar um modelo de dispositivo	Exclua um modelo de dispositivo existente por ID.
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 de dispositivo.
Excluir um dispositivo (preterido)	Exclua um dispositivo existente por ID de dispositivo (preterido).
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 de dispositivo e ID de relacionamento.
Excluir usuário	Eliminar um utilizador
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 module	Execute um comando em um módulo.
Lista de utilizadores	Obter a lista de usuários em um aplicativo
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	Liste todas as relações com base na ID do dispositivo.
Listar trabalhos agendados	Obtenha a lista de trabalhos agendados em um aplicativo.
Listar vagas	Obtenha a lista de trabalhos em um aplicativo.
Obter dispositivos por ID de 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 propriedades da nuvem do dispositivo (preterido)	Obtenha todos os valores de propriedade de nuvem de um dispositivo por ID de dispositivo (preterido).
Obter propriedades do dispositivo	Obtenha todos os valores de propriedade de um dispositivo por ID de dispositivo.
Obter propriedades do dispositivo (preterido)	Obtenha todos os valores de propriedade de um dispositivo por ID de dispositivo (preterido).
Obter propriedades do módulo	Obtenha todos os valores de propriedade de um módulo.
Obter relação com o dispositivo	Obtenha detalhes sobre uma relação de dispositivo existente por ID de dispositivo e por ID de relacionamento.
Obter resposta de comando do componente	Obtenha a última resposta para um comando de componente de dispositivo.
Obter resposta de comando do componente do módulo	Obtenha a última resposta para um comando de componente de 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 dispositivos individuais por ID de trabalho.
Obter trabalhos por ID de trabalho agendado	Obtenha a lista de trabalhos para uma definição de trabalho agendada.
Obter um dispositivo pela ID	Obtenha detalhes sobre um dispositivo existente por ID de dispositivo.
Obter um dispositivo por ID (preterido)	Obtenha detalhes sobre um dispositivo existente por ID de dispositivo (preterido).
Obter um grupo de dispositivos	Obtenha detalhes sobre um grupo de dispositivos existente por ID.
Obter um modelo de dispositivo por ID	Obtenha detalhes sobre um modelo de dispositivo 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 utilizador	Obter um utilizador por ID
Obter valor de telemetria de componente	Obtenha o último valor de telemetria de um componente.
Obter valor de telemetria do componente do módulo	Obtenha o último valor de telemetria de um componente de módulo.
Obter valor de telemetria do dispositivo	Obtenha o último valor de telemetria de um dispositivo.
Obter valor de telemetria do dispositivo (preterido)	Obtenha o último valor de telemetria de um dispositivo (preterido).
Obter valor de telemetria do módulo	Obtenha o último valor de telemetria de um módulo.
Parar um trabalho em execução	Pare 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 interrompido existente.

Atualizar propriedades da nuvem do dispositivo (preterido)

ID da Operação:: Devices_UpdateCloudProperties

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
ID do modelo de dispositivo	instanceOf		string	A definição de modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Propriedades do dispositivo.

Devoluções

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 de dispositivo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Propriedades do dispositivo.

Devoluções

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 de dispositivo (preterido).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
ID do modelo de dispositivo	instanceOf		string	A definição de modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Propriedades do dispositivo.

Devoluções

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

Atualizar propriedades do módulo

ID da Operação:: Devices_UpdateModuleProperties_V1

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

Parâmetros

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

Devoluções

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

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do trabalho agendado	scheduled_job_id	True	string	ID exclusivo do trabalho agendado.
Tipo de Fim de Agendamento	scheduled_job_end_type		string	Como o trabalho agendado deve terminar (não aplicado a migrações de modelo de dispositivo).
Body	body	True	dynamic	Corpo de criação de trabalho agendado.

Devoluções

A definição de trabalho agendado.

Body: ScheduledJobStatic

Atualizar uma relação de dispositivo

ID da Operação:: DeviceRelationships_Update

Atualize uma relação de dispositivo existente entre um determinado dispositivo e um novo dispositivo com um ID de dispositivo e um ID de relacionamento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
ID de relacionamento	relationship_id	True	string	ID exclusivo da relação do dispositivo.
ID de relacionamento do dispositivo	id		string	ID exclusivo da relação do dispositivo.
ID de destino do relacionamento do dispositivo	target	True	string	O ID do dispositivo do dispositivo de origem (filho).

Devoluções

Body: DeviceRelationshipStatic

Atualizar utilizador

ID da Operação:: Users_Update_V1

Atualizar um usuário no aplicativo via patch

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
User	user_id	True	string	ID exclusivo do usuário.
Tipo de utilizador	user_type		string	Tipo de utilizador.
Body	body	True	dynamic	Corpo de atualização do usuário.

Devoluções

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

Conseguir um emprego

ID da Operação:: Jobs_Get

Obtenha detalhes sobre um trabalho existente por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do trabalho	job_id	True	string	ID exclusivo do trabalho.

Devoluções

A definição do trabalho.

Body: JobStatic

Criar ou atualizar um dispositivo

ID da Operação:: Devices_Set_V2

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
ID do dispositivo	id		string	ID exclusivo do dispositivo.
Nome do dispositivo	displayName		string	Nome de exibição do dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.
Simulado	simulated		boolean	Se o dispositivo é simulado.
Ativado(a)	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 é suportada hoje, várias organizações serão suportadas em breve.
Aprovisionado	provisioned		boolean	Se os recursos foram alocados para o dispositivo.

Devoluções

Body: DeviceV2

Criar ou atualizar um dispositivo (preterido)

ID da Operação:: Devices_Set_V1

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
ID do dispositivo	id		string	ID exclusivo do dispositivo.
Nome do dispositivo	displayName		string	Nome de exibição do dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.
Simulado	simulated		boolean	Se o dispositivo é simulado.
Ativado(a)	enabled		boolean	Se a conexão do dispositivo com o IoT Central foi habilitada.
Aprovisionado	provisioned		boolean	Se os recursos foram alocados para o dispositivo.

Devoluções

Body: DeviceV1

Criar ou atualizar um dispositivo (preterido)

ID da Operação:: Devices_Set

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
ID do dispositivo	id		string	ID exclusivo do dispositivo.
Nome do dispositivo	displayName		string	Nome de exibição do dispositivo.
Modelo de dispositivo	instanceOf		string	A definição de modelo de dispositivo para o dispositivo.
Simulado	simulated		boolean	Se o dispositivo é simulado.
Aprovado	approved		boolean	Se o dispositivo foi aprovado para se conectar ao IoT Central.
Aprovisionado	provisioned		boolean	Se os recursos foram alocados para o dispositivo.

Devoluções

Body: Device

Criar um emprego

ID da Operação:: Jobs_Set

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do trabalho	job_id	True	string	ID exclusivo do trabalho.
Tipo de trabalho	job_type		string	Tipo de trabalho.
Body	body	True	dynamic	Corpo de criação de emprego.

Devoluções

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

Criar um grupo de dispositivos

ID da Operação:: DeviceGroups_Set

Crie ou atualize um grupo de dispositivos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do Grupo de Dispositivos	device_group_id	True	string	ID exclusivo do grupo de dispositivos.
ID do Grupo de Dispositivos	id		string	ID exclusivo do grupo de dispositivos.
Nome de exibição	displayName	True	string	Nome para exibição do grupo de dispositivos.
Filter	filter	True	string	Consulta definindo quais dispositivos devem estar nesse grupo.
Description	description		string	Breve resumo do grupo de dispositivos.
ETag	etag		string	ETag usado para evitar conflitos em atualizações de grupos de dispositivos.
Organizations	organizations		array of string	Lista de organizações do grupo de dispositivos, apenas uma organização é suportada hoje, várias organizações serão suportadas em breve.

Devoluções

A definição do grupo de dispositivos.

Body: DeviceGroup

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

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do trabalho agendado	scheduled_job_id	True	string	ID exclusivo do trabalho agendado.
Tipo de trabalho	job_type		string	Tipo de trabalho.
Tipo de Fim de Agendamento	scheduled_job_end_type		string	Como o trabalho agendado deve terminar (não aplicado a migrações de modelo de dispositivo).
Body	body	True	dynamic	Corpo de criação de trabalho agendado.

Devoluções

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

Criar uma nova organização

ID da Operação:: Organizations_Set

Crie uma nova organização.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID da Organização	organization_id	True	string	ID exclusivo da organização.
ID da Organização	id		string	ID exclusivo da organização.
Nome da Organização	displayName		string	Nome para exibição da organização.
Parent	parent		string	Nome para exibição da organização pai.

Devoluções

Body: Organization

Criar uma relação de dispositivo

ID da Operação:: DeviceRelationships_Set

Crie uma nova relação de dispositivo entre um determinado dispositivo e um novo dispositivo com um ID de dispositivo e um ID de relacionamento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID de relacionamento	relationship_id	True	string	ID exclusivo da relação do dispositivo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
ID de relacionamento do dispositivo	id		string	ID exclusivo da relação do dispositivo.
ID de destino do relacionamento do dispositivo	target	True	string	O ID do dispositivo do dispositivo de origem (filho).

Devoluções

Body: DeviceRelationshipStatic

Criar utilizador

ID da Operação:: Users_Create_V1

Criar um usuário no aplicativo

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
User	user_id	True	string	ID exclusivo do usuário.
Tipo de utilizador	user_type		string	Tipo de utilizador.
Body	body	True	dynamic	Usuário criar corpo.

Devoluções

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

Eliminar um modelo de dispositivo

ID da Operação:: DeviceTemplates_Remove_V1

Exclua um modelo de dispositivo existente por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
Template	template_id	True	string	ID exclusivo do modelo.

Excluir grupo de dispositivos

ID da Operação:: DeviceGroups_Remove

Excluir um grupo de dispositivos existente por ID

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do Grupo de Dispositivos	device_group_id	True	string	ID exclusivo do grupo de dispositivos.

Excluir organização

ID da Operação:: Organizations_Remove

Excluir uma organização existente por ID

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID da Organização	organization_id	True	string	ID exclusivo da organização.

Excluir um dispositivo

ID da Operação:: Devices_Remove_V1

Exclua um dispositivo existente por ID de dispositivo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.

Excluir um dispositivo (preterido)

ID da Operação:: Devices_Remove

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.

Excluir um trabalho agendado

ID da Operação:: ScheduledJobs_Remove

Exclua um trabalho agendado existente por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do trabalho agendado	scheduled_job_id	True	string	ID exclusivo do trabalho agendado.

Excluir uma relação de dispositivo

ID da Operação:: DeviceRelationships_Remove

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
ID de relacionamento	relationship_id	True	string	ID exclusivo da relação do dispositivo.

Excluir usuário

ID da Operação:: Users_Remove_V1

Eliminar um utilizador

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
User	user_id	True	string	ID exclusivo do usuário.

Executar um comando de componente

ID da Operação:: Devices_RunComponentCommand_V1

Execute um comando em um componente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Componente do dispositivo	component_name	True	string	Nome do componente do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando de dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Corpo de comando do dispositivo.

Devoluções

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

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Módulo de 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 de dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Corpo de comando do dispositivo.

Devoluções

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

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando de dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Corpo de comando do dispositivo.

Devoluções

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

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Componente do dispositivo	component_name	True	string	Nome do componente do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando de dispositivo.
ID do modelo de dispositivo	instanceOf		string	A definição de modelo de dispositivo para o dispositivo.
body	body	True	dynamic	Corpo de comando do dispositivo.

Devoluções

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

Executar um comando module

ID da Operação:: Devices_RunModuleCommand_V1

Execute um comando em um módulo.

Parâmetros

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

Devoluções

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

Lista de utilizadores

ID da Operação:: Users_List_V1

Obter a lista de usuários em um aplicativo

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.

Devoluções

Body: UserCollectionV1

Listar dispositivos

ID da Operação:: Devices_List_V1

Obtenha a lista de dispositivos em um aplicativo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.

Devoluções

Body: DeviceCollectionV1

Listar funções

ID da Operação:: Roles_List_V1

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.

Devoluções

Body: RoleCollectionV1

Listar grupos de dispositivos

ID da Operação:: DeviceGroups_List

Obtenha a lista de grupos de dispositivos em um aplicativo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.

Devoluções

Os resultados paginados de grupos de dispositivos.

Body: DeviceGroupCollection

Listar modelos de dispositivo

ID da Operação:: DeviceTemplates_List_V1

Obtenha a lista de modelos de dispositivo em um aplicativo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.

Devoluções

Body: DeviceTemplateCollectionV1

Listar organizações

ID da Operação:: Organizations_List

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.

Devoluções

Body: OrganizationCollection

Listar relações

ID da Operação:: DeviceRelationships_List

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.

Devoluções

Body: DeviceRelationshipCollection

Listar trabalhos agendados

ID da Operação:: ScheduledJobs_List

Obtenha a lista de trabalhos agendados em um aplicativo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.

Devoluções

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

Listar vagas

ID da Operação:: Jobs_List

Obtenha a lista de trabalhos em um aplicativo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.

Devoluções

Os resultados paginados dos empregos.

Body: JobCollection

Obter dispositivos por ID de grupo de dispositivos

ID da Operação:: DeviceGroups_GetDevices

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do Grupo de Dispositivos	device_group_id	True	string	ID exclusivo do grupo de dispositivos.

Devoluções

Os resultados paginados de dispositivos pertencentes ao grupo de dispositivos.

Body: DeviceGroupDeviceCollection

Obter função

ID da Operação:: Roles_Get_V1

Obtenha uma função por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
Funções	role_id	True	string	ID exclusivo para a função.

Devoluções

Body: RoleV1

Obter propriedades da nuvem do dispositivo (preterido)

ID da Operação:: Devices_GetCloudProperties

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
ID do modelo de dispositivo	instanceOf		string	A definição de modelo de dispositivo para o dispositivo.

Devoluções

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 de dispositivo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.

Devoluções

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

Obter propriedades do dispositivo (preterido)

ID da Operação:: Devices_GetProperties

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
ID do modelo de dispositivo	instanceOf		string	A definição de modelo de dispositivo para o dispositivo.

Devoluções

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

Obter propriedades do módulo

ID da Operação:: Devices_GetModuleProperties_V1

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Módulo de dispositivo	module	True	string	Nome do módulo do dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.

Devoluções

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

Obter relação com o dispositivo

ID da Operação:: DeviceRelationships_Get

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
ID de relacionamento	relationship_id	True	string	ID exclusivo da relação do dispositivo.

Devoluções

Body: DeviceRelationshipStatic

Obter resposta de comando do componente

ID da Operação:: Devices_GetComponentCommandResponse_V1

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Componente do dispositivo	component_name	True	string	Nome do componente do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando de dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.

Devoluções

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 de módulo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Módulo de 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 de dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.

Devoluções

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

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Comando do dispositivo	command_name	True	string	Nome deste comando de dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.

Devoluções

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

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

Devoluções

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 dispositivos individuais por ID de trabalho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do trabalho	job_id	True	string	ID exclusivo do trabalho.

Devoluções

Os resultados paginados dos status do dispositivo de trabalho.

Body: JobDeviceStatusCollection

Obter trabalhos por ID de trabalho agendado

ID da Operação:: ScheduledJobs_ListJobs

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do trabalho agendado	scheduled_job_id	True	string	ID exclusivo do trabalho agendado.

Devoluções

Os resultados paginados de definições de trabalho pertencentes a um trabalho agendado.

Body: ScheduledJobJobCollection

Obter um dispositivo pela ID

ID da Operação:: Devices_Get_V1

Obtenha detalhes sobre um dispositivo existente por ID de dispositivo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.

Devoluções

Body: DeviceV1

Obter um dispositivo por ID (preterido)

ID da Operação:: Devices_Get

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.

Devoluções

Body: Device

Obter um grupo de dispositivos

ID da Operação:: DeviceGroups_Get

Obtenha detalhes sobre um grupo de dispositivos existente por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do Grupo de Dispositivos	device_group_id	True	string	ID exclusivo do grupo de dispositivos.

Devoluções

A definição do grupo de dispositivos.

Body: DeviceGroup

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

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
Template	template_id	True	string	ID exclusivo do modelo.

Devoluções

Body: DeviceTemplateV1

Obter um trabalho agendado

ID da Operação:: ScheduledJobs_Get

Obtenha detalhes sobre um trabalho agendado existente por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do trabalho agendado	scheduled_job_id	True	string	ID exclusivo do trabalho agendado.

Devoluções

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

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID da Organização	organization_id	True	string	ID exclusivo da organização.

Devoluções

Body: Organization

Obter utilizador

ID da Operação:: Users_Get_V1

Obter um utilizador por ID

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
User	user_id	True	string	ID exclusivo do usuário.

Devoluções

Body: UserStaticV1

Obter valor de telemetria de componente

ID da Operação:: Devices_GetComponentTelemetryValue_V1

Obtenha o último valor de telemetria de um componente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Componente do dispositivo	component_name	True	string	Nome do componente do dispositivo.
Telemetria do dispositivo	telemetry_name	True	string	Nome da telemetria deste dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.

Devoluções

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

Obter valor de 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

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Módulo de 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 da telemetria deste dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.

Devoluções

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

Obter valor de telemetria do dispositivo

ID da Operação:: Devices_GetTelemetryValue_V1

Obtenha o último valor de telemetria de um dispositivo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Telemetria do dispositivo	telemetry_name	True	string	Nome da telemetria deste dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.

Devoluções

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

Obter valor de telemetria do dispositivo (preterido)

ID da Operação:: Devices_GetComponentTelemetryValue

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Componente do dispositivo	component_name	True	string	Nome do componente do dispositivo.
Telemetria do dispositivo	telemetry_name	True	string	Nome da telemetria deste dispositivo.
ID do modelo de dispositivo	instanceOf		string	A definição de modelo de dispositivo para o dispositivo.

Devoluções

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

Obter 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

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do dispositivo	device_id	True	string	ID exclusivo do dispositivo.
Módulo de dispositivo	module	True	string	Nome do módulo do dispositivo.
Telemetria do dispositivo	telemetry_name	True	string	Nome da telemetria deste dispositivo.
Modelo de dispositivo	template		string	A definição de modelo de dispositivo para o dispositivo.

Devoluções

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

Parar um trabalho em execução

ID da Operação:: Jobs_Stop

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do trabalho	job_id	True	string	ID exclusivo 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

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do trabalho	job_id	True	string	ID exclusivo do trabalho.
ID de execução repetida	rerun_id	True	string	ID exclusivo da nova execução.

Devoluções

A definição do trabalho.

Body: JobStatic

Retomar um trabalho interrompido

ID da Operação:: Jobs_Resume

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do trabalho	job_id	True	string	ID exclusivo do trabalho.

Acionadores

Quando uma regra é acionada

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

Quando uma regra é acionada

ID da Operação:: Workflow_CreateTrigger

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Aplicação	application	True	string	ID exclusivo do aplicativo.
ID do gatilho do fluxo de trabalho	id		string	ID exclusivo do gatilho do fluxo de trabalho.
Regra	rule	True	string	ID exclusiva da regra vinculada ao gatilho do fluxo de trabalho.

Devoluções

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

Definições

Device

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

DispositivoV1

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

DispositivoV2

Name	Caminho	Tipo	Description
ID do dispositivo	id	string	ID exclusivo do dispositivo.
Nome do dispositivo	displayName	string	Nome de exibição do dispositivo.
Modelo de dispositivo	template	string	A definição de modelo de dispositivo para o dispositivo.
Simulado	simulated	boolean	Se o dispositivo é simulado.
Ativado(a)	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 é suportada hoje, várias organizações serão suportadas em breve.
Aprovisionado	provisioned	boolean	Se os recursos foram alocados para o dispositivo.

DeviceCollectionV1

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

Grupo de dispositivos

A definição do grupo de dispositivos.

Name	Caminho	Tipo	Description
ID do Grupo de Dispositivos	id	string	ID exclusivo do grupo de dispositivos.
Nome de exibição	displayName	string	Nome para exibição do grupo de dispositivos.
Filter	filter	string	Consulta definindo quais dispositivos devem estar nesse grupo.
Description	description	string	Breve resumo do grupo de dispositivos.
ETag	etag	string	ETag usado para evitar conflitos em atualizações de grupos de dispositivos.
Organizations	organizations	array of string	Lista de organizações do grupo de dispositivos, apenas uma organização é suportada hoje, várias organizações serão suportadas em breve.

DeviceGroupCollection

Os resultados paginados de grupos de dispositivos.

Name	Caminho	Tipo	Description
ID do Grupo de Dispositivos	value	array of DeviceGroup	A coleção de grupos de dispositivos.
Próximo Link	nextLink	string	URL para obter a próxima página de grupos de dispositivos.

DeviceGroupDeviceCollection

Os resultados paginados de dispositivos pertencentes ao grupo de dispositivos.

Name	Caminho	Tipo	Description
valor	value	array of DeviceV1	A coleção de dispositivos pertencentes ao grupo de dispositivos.
Próximo Link	nextLink	string	URL para obter a próxima página de dispositivos no grupo.

DeviceRelationshipStatic

Name	Caminho	Tipo	Description
ID de relacionamento do dispositivo	id	string	ID exclusivo da relação do dispositivo.
ID da origem da relação do dispositivo	source	string	O ID do dispositivo do dispositivo de origem (pai).
ID de destino do relacionamento do dispositivo	target	string	O ID do dispositivo do dispositivo de origem (filho).

DeviceRelationshipCollection

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

DeviceTemplateV1

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

DeviceTemplateCollectionV1

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

JobDeviceStatus

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

Name	Caminho	Tipo	Description
ID do dispositivo	id	string	ID do dispositivo cujo status de trabalho está sendo fornecido.
Estado do dispositivo	status	string	Indica se o trabalho está iniciando, em execução, etc. para o dispositivo determinado.

JobDeviceStatusCollection

Os resultados paginados dos status do dispositivo de trabalho.

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

JobBatch

A definição de lote de trabalho.

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

JobCancellationThreshold

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

Name	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 a percentagem de dispositivos aos quais o limiar 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.

Name	Caminho	Tipo	Description
ID do trabalho	id	string	ID exclusivo do trabalho.
Nome de exibição	displayName	string	Nome para 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 de lote de trabalho.
cancelamentoLimiar	cancellationThreshold	JobCancellationThreshold	A definição do limite de cancelamento de trabalho.
Data	data	array of object	Dados relacionados com a operação que está a ser executada por este 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 é suportada hoje, várias organizações serão suportadas em breve.
ID do trabalho agendado	scheduledJobId	string	Id da definição de trabalho agendado que criou esse trabalho.

JobCollection

Os resultados paginados dos empregos.

Name	Caminho	Tipo	Description
valor	value	array of JobStatic	A coleção de empregos.
Próximo Link	nextLink	string	URL para obter a próxima página de empregos.

Organização

Name	Caminho	Tipo	Description
ID da Organização	id	string	ID exclusivo da organização.
Nome da Organização	displayName	string	Nome para exibição da organização.
Parent	parent	string	Nome para exibição da organização pai.

OrganizationCollection

Name	Caminho	Tipo	Description
valor	value	array of Organization	O conjunto de organizações.
Próximo Link	nextLink	string	URL para obter a próxima página das organizações.

RoleV1

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

RoleCollectionV1

Name	Caminho	Tipo	Description
valor	value	array of RoleV1	A coleção de papéis.

ScheduledJobStatic

A definição de trabalho agendado.

Name	Caminho	Tipo	Description
ETag	etag	string	ETag usado para evitar conflitos em atualizações de trabalho agendadas.
ID do trabalho agendado	id	string	ID exclusivo do trabalho agendado.
Nome de exibição	displayName	string	Nome para 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 de lote de trabalho.
cancelamentoLimiar	cancellationThreshold	JobCancellationThreshold	A definição do limite de cancelamento de trabalho.
Data	data	array of object	Dados relacionados com a operação que está a ser executada por este 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 é suportada hoje, várias organizações serão suportadas em breve.
Schedule	schedule	object	O cronograma no qual executar o trabalho.
Ativado(a)	enabled	boolean	Se o trabalho agendado está habilitado.
Concluído	completed	boolean	Se o trabalho agendado foi concluído.

ScheduledJobJobCollection

Os resultados paginados de definições de trabalho pertencentes a um trabalho agendado.

Name	Caminho	Tipo	Description
valor	value	array of JobStatic	A coleção de empregos.
Próximo Link	nextLink	string	URL para obter a próxima página de empregos.

UserStaticV1

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

UserCollectionV1

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

FunçãoAtribuiçãoV1

Name	Caminho	Tipo	Description
Funções	role	string	ID da função para esta atribuição de função.

Partilhar via

Azure IoT Central V3 (Pré-visualização)

Pré-requisitos

Como obter credenciais

Notas de lançamento

Setembro de 2021

Novembro de 2021

Problemas conhecidos e limitações

A criar uma ligação

Credentials

Padrão [DEPRECATED]

Limites de Limitação

Ações

Atualizar propriedades da nuvem do dispositivo (preterido)

Parâmetros

Devoluções

Atualizar propriedades do dispositivo

Parâmetros

Devoluções

Atualizar propriedades do dispositivo (preterido)

Parâmetros

Devoluções

Atualizar propriedades do módulo

Parâmetros

Devoluções

Atualizar um trabalho agendado

Parâmetros

Devoluções

Atualizar uma relação de dispositivo

Parâmetros

Devoluções

Atualizar utilizador

Parâmetros

Devoluções

Conseguir um emprego

Parâmetros

Devoluções

Criar ou atualizar um dispositivo

Parâmetros

Devoluções

Criar ou atualizar um dispositivo (preterido)

Parâmetros

Devoluções

Criar ou atualizar um dispositivo (preterido)

Parâmetros

Devoluções

Criar um emprego

Parâmetros

Devoluções

Criar um grupo de dispositivos

Parâmetros

Devoluções

Criar um trabalho agendado

Parâmetros

Devoluções

Criar uma nova organização

Parâmetros

Devoluções

Criar uma relação de dispositivo

Parâmetros

Devoluções

Criar utilizador

Parâmetros

Devoluções

Eliminar um modelo de dispositivo

Parâmetros

Excluir grupo de dispositivos

Parâmetros

Excluir organização

Parâmetros

Excluir um dispositivo

Parâmetros

Excluir um dispositivo (preterido)

Parâmetros

Excluir um trabalho agendado

Parâmetros

Excluir uma relação de dispositivo

Parâmetros

Excluir usuário

Parâmetros