Partilhar via

Registry class

  • Referência
Pacote:
azure-iothub

A classe Registry fornece acesso ao serviço de identidade do dispositivo Hub IoT. Os utilizadores do SDK devem instanciar esta classe com um dos métodos de fábrica: fromConnectionString ou fromSharedAccessSignature.

O protocolo utilizado para operações de registo de identidade do dispositivo é HTTPS.

Métodos

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)

Adicione uma configuração a um hub IoT.
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Adiciona uma matriz de dispositivos.
addModule(Module)
addModule(Module, HttpResponseCallback<any>)

Adicione o módulo especificado ao registo.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Aplicar a configuração especificada a um dispositivo num Hub IoT
cancelJob(string)
cancelJob(string, Callback<JobStatus>)

Cancelar uma tarefa de importação/exportação em massa.
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)

Cria uma nova identidade de dispositivo num hub IoT.
createQuery(string, number)

Cria uma consulta que pode ser executada no Hub IoT instância para encontrar informações sobre dispositivos ou tarefas.
delete(string)
delete(string, HttpResponseCallback<any>)

Remove uma identidade de dispositivo existente de um hub IoT.
exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Exportar dispositivos para um blob numa tarefa em massa.
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Exportar dispositivos para um blob numa tarefa em massa com uma identidade configurada.
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)

Constrói um objeto de Registo a partir da cadeia de ligação especificada.
fromSharedAccessSignature(string)

Constrói um objeto de Registo a partir da assinatura de acesso partilhado especificada.
fromTokenCredential(string, TokenCredential)

Constrói um objeto de Registo a partir do Azure TokenCredential especificado.
get(string)
get(string, HttpResponseCallback<Device>)

Solicita informações sobre uma identidade de dispositivo existente num hub IoT.
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)

Obter uma única configuração a partir de um Hub IoT
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)

Obter todas as configurações num Hub IoT
getJob(string)
getJob(string, Callback<JobStatus>)

Obtenha o estado de uma tarefa de importação/exportação em massa.
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)

Obter um único módulo a partir de um dispositivo num Hub IoT
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)

Obter uma lista de todos os módulos num dispositivo Hub IoT
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)

Obtém o Módulo Duplo do módulo com o identificador de módulo especificado.
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

Obtém estatísticas sobre os dispositivos no registo de identidade do dispositivo.
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)

Obtém o Dispositivo Duplo do dispositivo com o identificador de dispositivo especificado.
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)

Importa dispositivos de um blob numa tarefa em massa.
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

Importa dispositivos de um blob numa tarefa em massa com uma identidade configurada.
importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)

Solicita informações sobre as primeiras 1000 identidades de dispositivos num hub IoT.
listJobs()
listJobs(HttpResponseCallback<any>)

Liste as últimas tarefas de importação/exportação (incluindo a ativa, se existirem).
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)

Remover uma configuração com o ID fornecido de um Hub IoT
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)

Atualizações uma matriz de dispositivos.
removeModule(Module, TripleValueCallback<any, any>)

Remover o módulo especificado do registo
removeModule(string | Module)
removeModule(string | Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)

Atualizações uma identidade de dispositivo existente num hub IoT com as informações do dispositivo fornecidas. O deviceInfo parâmetro tem de incluir todas as propriedades que são atualizáveis. Por exemplo, se atualizar a status propriedade de disabled para enabled, o deviceInfo objeto também deve ter statusReason, autenticação (e respetivas sub-propriedades), capacidades e deviceScope definidos para os valores atuais dos dispositivos ou essas propriedades serão repostas. Recomenda-se que a api get seja chamada primeiro antes de efetuar uma atualização.
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)

Atualizar uma configuração num hub IoT
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)

Atualizações uma matriz de dispositivos. Os elementos individuais do devices parâmetro têm de incluir todas as propriedades que são atualizáveis. Por exemplo, se atualizar a status propriedade de disabled para enabled, o objeto também deve ter statusReason, autenticação (e respetivas subproprências), capacidades e deviceScope definidos para os valores atuais dos dispositivos ou essas propriedades serão repostas. Recomenda-se que a api get seja chamada primeiro antes de efetuar uma atualização.
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)

Atualizar o objeto de módulo especificado no registo
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)

Atualizações o Duplo de um módulo específico com o patch especificado.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)

Atualizações o Dispositivo Duplo de um dispositivo específico com o patch especificado.

Detalhes de Método

addConfiguration(Configuration) 

function addConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>

Parâmetros

configuration
Configuration

Devoluções

Promise<ResultWithHttpResponse<any>>

addConfiguration(Configuration, HttpResponseCallback<any>)

Adicione uma configuração a um hub IoT.

function addConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)

Parâmetros

configuration
Configuration

Um objeto do tipo module:azure-iothub. Configuração para adicionar ao hub

done

HttpResponseCallback<any>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de erro (pode ser nulo), o corpo da resposta e um objeto de resposta específico do transporte útil para registo ou depuração.

addDevices(DeviceDescription[]) 

function addDevices(devices: DeviceDescription[]): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

Parâmetros

devices

DeviceDescription[]

Devoluções

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Adiciona uma matriz de dispositivos.

function addDevices(devices: DeviceDescription[], done?: HttpResponseCallback<BulkRegistryOperationResult>)

Parâmetros

devices

DeviceDescription[]

Uma matriz de objetos que tem de incluir uma deviceId propriedade cujo valor é um identificador de dispositivo válido.

done

HttpResponseCallback<BulkRegistryOperationResult>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de erro (pode ser nulo), bulkRegistryOperationResult e um objeto de resposta específico do transporte útil para registo ou depuração.

addModule(Module) 

function addModule(module: Module): Promise<ResultWithHttpResponse<any>>

Parâmetros

module
Module

Devoluções

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

Adicione o módulo especificado ao registo.

function addModule(module: Module, done?: HttpResponseCallback<any>)

Parâmetros

module
Module

Objeto de módulo a adicionar ao registo.

done

HttpResponseCallback<any>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de erro (pode ser nulo), o corpo da resposta e um objeto de resposta específico do transporte útil para registo ou depuração.

applyConfigurationContentOnDevice(string, ConfigurationContent) 

function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent): Promise<ResultWithHttpResponse<any>>

Parâmetros

deviceId

string

content
ConfigurationContent

Devoluções

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Aplicar a configuração especificada a um dispositivo num Hub IoT

function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent, done?: HttpResponseCallback<any>)

Parâmetros

deviceId

string

ID do dispositivo para aplicar a configuração a

content
ConfigurationContent

A Configuração a aplicar

done

HttpResponseCallback<any>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de erro (pode ser nulo), o corpo da resposta e um objeto de resposta específico do transporte útil para registo ou depuração.

cancelJob(string) 

function cancelJob(jobId: string): Promise<JobStatus>

Parâmetros

jobId

string

Devoluções

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

Cancelar uma tarefa de importação/exportação em massa.

function cancelJob(jobId: string, done?: Callback<JobStatus>)

Parâmetros

jobId

string

O identificador da tarefa para a qual o utilizador quer obter informações de estado.

done

Callback<JobStatus>

A função opcional a chamar com dois argumentos: um objeto de erro se ocorrer um erro (nulo, caso contrário) e o estado (cancelado) da tarefa cujo identificador foi transmitido como argumento.

create(DeviceDescription) 

function create(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>

Parâmetros

deviceInfo
DeviceDescription

Devoluções

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

Cria uma nova identidade de dispositivo num hub IoT.

function create(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)

Parâmetros

deviceInfo
DeviceDescription

O objeto tem de incluir uma deviceId propriedade com um identificador de dispositivo válido.

done

HttpResponseCallback<Device>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de erro (pode ser nulo), um Objeto de dispositivo que representa a identidade de dispositivo criada e um objeto de resposta específico do transporte útil para o registo ou depuração.

createQuery(string, number)

Cria uma consulta que pode ser executada no Hub IoT instância para encontrar informações sobre dispositivos ou tarefas.

function createQuery(sqlQuery: string, pageSize?: number): Query

Parâmetros

sqlQuery

string

A consulta escrita como uma cadeia de SQL.

pageSize

number

O número pretendido de resultados por página (opcional. predefinição: 1000, máximo: 10000).

Devoluções

Query

delete(string) 

function delete(deviceId: string): Promise<ResultWithHttpResponse<any>>

Parâmetros

deviceId

string

Devoluções

Promise<ResultWithHttpResponse<any>>

delete(string, HttpResponseCallback<any>)

Remove uma identidade de dispositivo existente de um hub IoT.

function delete(deviceId: string, done?: HttpResponseCallback<any>)

Parâmetros

deviceId

string

O identificador de uma identidade de dispositivo existente.

done

HttpResponseCallback<any>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de erro (pode ser nulo), um argumento sempre nulo (para consistência com os outros métodos) e um objeto de resposta específico do transporte útil para registo ou depuração.

exportDevicesToBlob(string, boolean) 

function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>

Parâmetros

outputBlobContainerUri

string

excludeKeys

boolean

Devoluções

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Exportar dispositivos para um blob numa tarefa em massa.

function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)

Parâmetros

outputBlobContainerUri

string

O URI para um contentor onde será criado um blob com o nome "devices.txt" que contém a lista de dispositivos.

excludeKeys

boolean

Valor booleano que indica se as chaves de segurança devem ser excluídas dos dados exportados.

done

Callback<JobStatus>

A função opcional a chamar quando a tarefa tiver sido criada, com dois argumentos: um objeto de erro se ocorrer um erro (nulo, caso contrário) e o estado da tarefa que pode ser utilizado para controlar o progresso da exportação dos dispositivos.

exportDevicesToBlobByIdentity(string, boolean) 

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>

Parâmetros

outputBlobContainerUri

string

excludeKeys

boolean

Devoluções

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Exportar dispositivos para um blob numa tarefa em massa com uma identidade configurada.

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)

Parâmetros

outputBlobContainerUri

string

O URI para um contentor onde será criado um blob com o nome "devices.txt" que contém a lista de dispositivos.

excludeKeys

boolean

Valor booleano que indica se as chaves de segurança devem ser excluídas dos dados exportados.

done

Callback<JobStatus>

A função opcional a chamar quando a tarefa tiver sido criada, com dois argumentos: um objeto de erro se ocorrer um erro (nulo, caso contrário) e o estado da tarefa que pode ser utilizado para controlar o progresso da exportação dos dispositivos.

exportDevicesToBlobByIdentity(string, boolean, string) 

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string): Promise<JobStatus>

Parâmetros

outputBlobContainerUri

string

excludeKeys

boolean

userAssignedIdentity

string

Devoluções

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>) 

function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string, done: Callback<JobStatus>)

Parâmetros

outputBlobContainerUri

string

excludeKeys

boolean

userAssignedIdentity

string

done

Callback<JobStatus>

fromConnectionString(string)

Constrói um objeto de Registo a partir da cadeia de ligação especificada.

static function fromConnectionString(value: string): Registry

Parâmetros

value

string

Uma cadeia de ligação que encapsula as permissões de Registo adequadas (leitura e/ou escrita).

Devoluções

Registry

fromSharedAccessSignature(string)

Constrói um objeto de Registo a partir da assinatura de acesso partilhado especificada.

static function fromSharedAccessSignature(value: string): Registry

Parâmetros

value

string

Uma assinatura de acesso partilhado que encapsula as permissões de Registo adequadas (leitura e/ou escrita).

Devoluções

Registry

fromTokenCredential(string, TokenCredential)

Constrói um objeto de Registo a partir do Azure TokenCredential especificado.

static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): Registry

Parâmetros

hostName

string

Nome do anfitrião do serviço do Azure.

tokenCredential
TokenCredential

Um TokenCredential do Azure utilizado para autenticar com o serviço do Azure

Devoluções

Registry

get(string) 

function get(deviceId: string): Promise<ResultWithHttpResponse<Device>>

Parâmetros

deviceId

string

Devoluções

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

Solicita informações sobre uma identidade de dispositivo existente num hub IoT.

function get(deviceId: string, done?: HttpResponseCallback<Device>)

Parâmetros

deviceId

string

O identificador de uma identidade de dispositivo existente.

done

HttpResponseCallback<Device>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de erro (pode ser nulo), um Objeto de dispositivo que representa a identidade de dispositivo criada e um objeto de resposta específico do transporte útil para o registo ou depuração.

getConfiguration(string) 

function getConfiguration(configurationId: string): Promise<ResultWithHttpResponse<Configuration>>

Parâmetros

configurationId

string

Devoluções

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

Obter uma única configuração a partir de um Hub IoT

function getConfiguration(configurationId: string, done?: HttpResponseCallback<Configuration>)

Parâmetros

configurationId

string

O ID da configuração que tem para obter

done

HttpResponseCallback<Configuration>

A chamada de retorno opcional que será chamada com um objeto de Erro ou um módulo:azure-iothub. Objeto de configuração com os detalhes de configuração.

getConfigurations() 

function getConfigurations(): Promise<ResultWithHttpResponse<Configuration[]>>

Devoluções

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

Obter todas as configurações num Hub IoT

function getConfigurations(done?: HttpResponseCallback<Configuration[]>)

Parâmetros

done

HttpResponseCallback<Configuration[]>

A chamada de retorno opcional que será chamada com um objeto de Erro ou uma matriz do módulo:azure-iothub. Objetos de configuração para todas as configurações.

getJob(string) 

function getJob(jobId: string): Promise<JobStatus>

Parâmetros

jobId

string

Devoluções

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

Obtenha o estado de uma tarefa de importação/exportação em massa.

function getJob(jobId: string, done?: Callback<JobStatus>)

Parâmetros

jobId

string

O identificador da tarefa para a qual o utilizador quer obter informações de estado.

done

Callback<JobStatus>

A função opcional a chamar com dois argumentos: um objeto de erro se ocorrer um erro (nulo, caso contrário) e o estado da tarefa cujo identificador foi transmitido como argumento.

getModule(string, string) 

function getModule(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Module>>

Parâmetros

deviceId

string

moduleId

string

Devoluções

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

Obter um único módulo a partir de um dispositivo num Hub IoT

function getModule(deviceId: string, moduleId: string, done?: HttpResponseCallback<Module>)

Parâmetros

deviceId

string

ID do dispositivo que é o proprietário do módulo.

moduleId

string

ID do Módulo a obter

done

HttpResponseCallback<Module>

A chamada de retorno opcional que será chamada com um objeto de Erro ou o módulo:azure-iothub. Objeto de módulo para o módulo pedido

getModulesOnDevice(string) 

function getModulesOnDevice(deviceId: string): Promise<ResultWithHttpResponse<Module[]>>

Parâmetros

deviceId

string

Devoluções

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

Obter uma lista de todos os módulos num dispositivo Hub IoT

function getModulesOnDevice(deviceId: string, done?: HttpResponseCallback<Module[]>)

Parâmetros

deviceId

string

ID do dispositivo para o qual estamos a obter módulos

done

HttpResponseCallback<Module[]>

A chamada de retorno opcional que será chamada com um objeto de Erro ou uma matriz do módulo:azure-iothub. Objetos de módulo para todos os módulos.

getModuleTwin(string, string) 

function getModuleTwin(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Twin>>

Parâmetros

deviceId

string

moduleId

string

Devoluções

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

Obtém o Módulo Duplo do módulo com o identificador de módulo especificado.

function getModuleTwin(deviceId: string, moduleId: string, done?: HttpResponseCallback<Twin>)

Parâmetros

deviceId

string

O identificador do dispositivo.

moduleId

string

O identificador do módulo.

done

HttpResponseCallback<Twin>

A chamada de retorno opcional que será chamada com um objeto de erro ou a instância do módulo duplo.

getRegistryStatistics() 

function getRegistryStatistics(): Promise<ResultWithHttpResponse<RegistryStatistics>>

Devoluções

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

Obtém estatísticas sobre os dispositivos no registo de identidade do dispositivo.

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Parâmetros

done

HttpResponseCallback<RegistryStatistics>

A chamada de retorno opcional que será chamada com um objeto de erro ou com as estatísticas do registo do dispositivo.

getTwin(string) 

function getTwin(deviceId: string): Promise<ResultWithHttpResponse<Twin>>

Parâmetros

deviceId

string

Devoluções

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

Obtém o Dispositivo Duplo do dispositivo com o identificador de dispositivo especificado.

function getTwin(deviceId: string, done?: HttpResponseCallback<Twin>)

Parâmetros

deviceId

string

O identificador do dispositivo.

done

HttpResponseCallback<Twin>

A chamada de retorno opcional que será chamada com um objeto de erro ou a instância do dispositivo duplo.

importDevicesFromBlob(string, string) 

function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>

Parâmetros

inputBlobContainerUri

string

outputBlobContainerUri

string

Devoluções

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

Importa dispositivos de um blob numa tarefa em massa.

function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)

Parâmetros

inputBlobContainerUri

string

O URI para um contentor com um blob denominado "devices.txt" que contém uma lista de dispositivos a importar.

outputBlobContainerUri

string

O URI para um contentor onde será criado um blob com registos do processo de importação.

done

Callback<JobStatus>

A função opcional a chamar quando a tarefa foi criada, com dois argumentos: um objeto de erro se ocorrer um erro (nulo, caso contrário) e o estado da tarefa que pode ser utilizado para controlar o progresso da importação de dispositivos.

importDevicesFromBlobByIdentity(string, string) 

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>

Parâmetros

inputBlobContainerUri

string

outputBlobContainerUri

string

Devoluções

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

Importa dispositivos de um blob numa tarefa em massa com uma identidade configurada.

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)

Parâmetros

inputBlobContainerUri

string

O URI para um contentor com um blob denominado "devices.txt" que contém uma lista de dispositivos a importar.

outputBlobContainerUri

string

O URI para um contentor onde será criado um blob com registos do processo de importação.

done

Callback<JobStatus>

A função opcional a chamar quando a tarefa foi criada, com dois argumentos: um objeto de erro se ocorrer um erro (nulo, caso contrário) e o estado da tarefa que pode ser utilizado para controlar o progresso da importação de dispositivos.

importDevicesFromBlobByIdentity(string, string, string) 

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string): Promise<JobStatus>

Parâmetros

inputBlobContainerUri

string

outputBlobContainerUri

string

userAssignedIdentity

string

Devoluções

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>) 

function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string, done: Callback<JobStatus>)

Parâmetros

inputBlobContainerUri

string

outputBlobContainerUri

string

userAssignedIdentity

string

done

Callback<JobStatus>

list() 

function list(): Promise<ResultWithHttpResponse<Device[]>>

Devoluções

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

Solicita informações sobre as primeiras 1000 identidades de dispositivos num hub IoT.

function list(done?: HttpResponseCallback<Device[]>)

Parâmetros

done

HttpResponseCallback<Device[]>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de erro (pode ser nulo), uma matriz de Objetos de dispositivo que representam as identidades de dispositivo listadas e um objeto de resposta específico do transporte útil para registo ou depuração.

listJobs() 

function listJobs(): Promise<ResultWithHttpResponse<any>>

Devoluções

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

Liste as últimas tarefas de importação/exportação (incluindo a ativa, se existirem).

function listJobs(done?: HttpResponseCallback<any>)

Parâmetros

done

HttpResponseCallback<any>

A função opcional a chamar com dois argumentos: um objeto de erro se ocorrer um erro (nulo, caso contrário) e a lista de tarefas anteriores como argumento.

removeConfiguration(string) 

function removeConfiguration(configurationId: string): Promise<ResultWithHttpResponse<any>>

Parâmetros

configurationId

string

Devoluções

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

Remover uma configuração com o ID fornecido de um Hub IoT

function removeConfiguration(configurationId: string, done?: HttpResponseCallback<any>)

Parâmetros

configurationId

string

ID da configuração a remover

done

HttpResponseCallback<any>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de erro (pode ser nulo), o corpo da resposta e um objeto de resposta específico do transporte útil para registo ou depuração.

removeDevices(DeviceDescription[], boolean) 

function removeDevices(devices: DeviceDescription[], forceRemove: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

Parâmetros

devices

DeviceDescription[]

forceRemove

boolean

Devoluções

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)

Atualizações uma matriz de dispositivos.

function removeDevices(devices: DeviceDescription[], forceRemove: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)

Parâmetros

devices

DeviceDescription[]

Uma matriz de objetos que tem de incluir uma deviceId propriedade cujo valor é um identificador de dispositivo válido.

forceRemove

boolean

se forceRemove for verdadeiro, o dispositivo será removido independentemente de um etag. Caso contrário, os etags têm de corresponder.

done

HttpResponseCallback<BulkRegistryOperationResult>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de erro (pode ser nulo), bulkRegistryOperationResult e um objeto de resposta específico do transporte útil para registo ou depuração.

removeModule(Module, TripleValueCallback<any, any>)

Remover o módulo especificado do registo

function removeModule(module: Module, done?: TripleValueCallback<any, any>)

Parâmetros

module
Module
done

TripleValueCallback<any, any>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de erro (pode ser nulo), o corpo da resposta e um objeto de resposta específico do transporte útil para registo ou depuração.

removeModule(string | Module) 

function removeModule(moduleOrDeviceId: string | Module): Promise<ResultWithHttpResponse<any>>

Parâmetros

moduleOrDeviceId

string | Module

Devoluções

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string) 

function removeModule(moduleOrDeviceId: string | Module, moduleId: string): Promise<ResultWithHttpResponse<any>>

Parâmetros

moduleOrDeviceId

string | Module

moduleId

string

Devoluções

Promise<ResultWithHttpResponse<any>>

removeModule(string, string, TripleValueCallback<any, any>) 

function removeModule(deviceId: string, moduleId: string, done: TripleValueCallback<any, any>)

Parâmetros

deviceId

string

moduleId

string

done

TripleValueCallback<any, any>

update(DeviceDescription) 

function update(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>

Parâmetros

deviceInfo
DeviceDescription

Devoluções

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

Atualizações uma identidade de dispositivo existente num hub IoT com as informações do dispositivo fornecidas. O deviceInfo parâmetro tem de incluir todas as propriedades que são atualizáveis. Por exemplo, se atualizar a status propriedade de disabled para enabled, o deviceInfo objeto também deve ter statusReason, autenticação (e respetivas sub-propriedades), capacidades e deviceScope definidos para os valores atuais dos dispositivos ou essas propriedades serão repostas. Recomenda-se que a api get seja chamada primeiro antes de efetuar uma atualização.

function update(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)

Parâmetros

deviceInfo
DeviceDescription

Um objeto que tem de incluir uma deviceId propriedade cujo valor é um identificador de dispositivo válido.

done

HttpResponseCallback<Device>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de erro (pode ser nulo), um Objeto de dispositivo que representa a identidade do dispositivo atualizada e um objeto de resposta específico do transporte útil para registo ou depuração.

updateConfiguration(Configuration) 

function updateConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>

Parâmetros

configuration
Configuration

Devoluções

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean) 

function updateConfiguration(configuration: Configuration, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>

Parâmetros

configuration
Configuration
forceUpdate

boolean

Devoluções

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean, HttpResponseCallback<any>) 

function updateConfiguration(configuration: Configuration, forceUpdate: boolean, done: HttpResponseCallback<any>)

Parâmetros

configuration
Configuration
forceUpdate

boolean

done

HttpResponseCallback<any>

updateConfiguration(Configuration, HttpResponseCallback<any>)

Atualizar uma configuração num hub IoT

function updateConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)

Parâmetros

configuration
Configuration

Um objeto do tipo module:azure-iothub. Configuração para adicionar ao hub

done

HttpResponseCallback<any>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de erro (pode ser nulo), o corpo da resposta e um objeto de resposta específico do transporte útil para registo ou depuração.

updateDevices(DeviceDescription[], boolean) 

function updateDevices(devices: DeviceDescription[], forceUpdate: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

Parâmetros

devices

DeviceDescription[]

forceUpdate

boolean

Devoluções

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)

Atualizações uma matriz de dispositivos. Os elementos individuais do devices parâmetro têm de incluir todas as propriedades que são atualizáveis. Por exemplo, se atualizar a status propriedade de disabled para enabled, o objeto também deve ter statusReason, autenticação (e respetivas subproprências), capacidades e deviceScope definidos para os valores atuais dos dispositivos ou essas propriedades serão repostas. Recomenda-se que a api get seja chamada primeiro antes de efetuar uma atualização.

function updateDevices(devices: DeviceDescription[], forceUpdate: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)

Parâmetros

devices

DeviceDescription[]

Uma matriz de objetos que tem de incluir uma deviceId propriedade cujo valor é um identificador de dispositivo válido.

forceUpdate

boolean

se forceUpdate for verdadeiro, o dispositivo será atualizado independentemente de uma etag. Caso contrário, as etags têm de corresponder.

done

HttpResponseCallback<BulkRegistryOperationResult>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de Erro (pode ser nulo), um BulkRegistryOperationResult e um objeto de resposta específico do transporte útil para registo ou depuração.

updateModule(Module) 

function updateModule(module: Module): Promise<ResultWithHttpResponse<any>>

Parâmetros

module
Module

Devoluções

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean) 

function updateModule(module: Module, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>

Parâmetros

module
Module
forceUpdate

boolean

Devoluções

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean, HttpResponseCallback<any>) 

function updateModule(module: Module, forceUpdate: boolean, done: HttpResponseCallback<any>)

Parâmetros

module
Module
forceUpdate

boolean

done

HttpResponseCallback<any>

updateModule(Module, TripleValueCallback<any, any>)

Atualizar o objeto de módulo especificado no registo

function updateModule(module: Module, done?: TripleValueCallback<any, any>)

Parâmetros

module
Module

Objeto de módulo a atualizar.

done

TripleValueCallback<any, any>

A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de Erro (pode ser nulo), o corpo da resposta e um objeto de resposta específico do transporte útil para o registo ou depuração.

updateModuleTwin(string, string, any, string) 

function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>

Parâmetros

deviceId

string

moduleId

string

patch

any

etag

string

Devoluções

Promise<ResultWithHttpResponse<Twin>>

updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)

Atualizações o Duplo de um módulo específico com o patch especificado.

function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)

Parâmetros

deviceId

string

O identificador do dispositivo.

moduleId

string

O identificador do módulo

patch

any

As propriedades e etiquetas pretendidas para corrigir o módulo duplo com.

etag

string

O etag mais recente para este módulo duplo ou "*" para forçar uma atualização mesmo que o módulo duplo tenha sido atualizado desde que o etag foi obtido.

done

HttpResponseCallback<Twin>

A chamada de retorno opcional que será chamada com um objeto error ou a instância do módulo duplo.

updateTwin(string, any, string) 

function updateTwin(deviceId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>

Parâmetros

deviceId

string

patch

any

etag

string

Devoluções

Promise<ResultWithHttpResponse<Twin>>

updateTwin(string, any, string, HttpResponseCallback<Twin>)

Atualizações o Dispositivo Duplo de um dispositivo específico com o patch especificado.

function updateTwin(deviceId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)

Parâmetros

deviceId

string

O identificador do dispositivo.

patch

any

As propriedades e etiquetas pretendidas para corrigir o dispositivo duplo com.

etag

string

O etag mais recente para este dispositivo duplo ou "*" para forçar uma atualização mesmo que o dispositivo duplo tenha sido atualizado desde que o etag foi obtido.

done

HttpResponseCallback<Twin>

A chamada de retorno opcional que será chamada com um objeto error ou a instância do dispositivo duplo.