Registry class

Pacote:

azure-iothub

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

O protocolo usado para operações de registro 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 registro.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	Aplicar a configuração fornecida a um dispositivo em um Hub IoT
cancelJob(string)
cancelJob(string, Callback<JobStatus>)	Cancelar um trabalho de importação/exportação em massa.
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)	Cria uma nova identidade de dispositivo em um hub IoT.
createQuery(string, number)	Cria uma consulta que pode ser executada na instância Hub IoT para encontrar informações sobre dispositivos ou trabalhos.
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 em um trabalho em massa.
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	Exportar dispositivos para um blob em um trabalho em massa usando uma identidade configurada.
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	Constrói um objeto Registry a partir da cadeia de conexão fornecida.
fromSharedAccessSignature(string)	Constrói um objeto registry a partir da assinatura de acesso compartilhado fornecida.
fromTokenCredential(string, TokenCredential)	Constrói um objeto registry do TokenCredential do Azure fornecido.
get(string)
get(string, HttpResponseCallback<Device>)	Solicita informações sobre uma identidade de dispositivo existente em um hub IoT.
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)	Obter uma única configuração de um Hub IoT
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	Obter todas as configurações em um Hub IoT
getJob(string)
getJob(string, Callback<JobStatus>)	Obtenha o status de um trabalho de importação/exportação em massa.
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)	Obter um único módulo de um dispositivo em um Hub IoT
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	Obter uma lista de todos os módulos em um dispositivo Hub IoT
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)	Obtém o Módulo Gêmeo do módulo com o identificador de módulo especificado.
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)	Obtém estatísticas sobre os dispositivos no registro de identidade do dispositivo.
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)	Obtém o Dispositivo Gêmeo do dispositivo com o identificador de dispositivo especificado.
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)	Importa dispositivos de um blob no trabalho em massa.
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)	Importa dispositivos de um blob no trabalho em massa usando 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 dispositivo em um hub IoT.
listJobs()
listJobs(HttpResponseCallback<any>)	Liste os últimos trabalhos de importação/exportação (incluindo o ativo, se houver).
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	Remover uma configuração com a ID fornecida 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 registro
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 em um hub IoT com as informações de dispositivo fornecidas. O deviceInfo parâmetro deve incluir todas as propriedades atualizáveis. Por exemplo, se atualizar a status propriedade de disabled para enabled, o deviceInfo objeto também deverá ter o statusReason, autenticação (e suas subpropriedades), funcionalidades e deviceScope definidos para os valores atuais dos dispositivos ou essas propriedades serão redefinidas. É recomendável que a aPI get seja chamada primeiro antes de fazer uma atualização.
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)	Atualizar uma configuração em um hub IoT
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Atualizações uma matriz de dispositivos. Os elementos individuais do devices parâmetro devem incluir todas as propriedades atualizáveis. Por exemplo, se atualizar a status propriedade de disabled para enabled, o objeto também deverá ter o statusReason, autenticação (e suas subpropriedades), funcionalidades e deviceScope definidos para os valores atuais dos dispositivos ou essas propriedades serão redefinidas. É recomendável que a aPI get seja chamada primeiro antes de fazer uma atualização.
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)	Atualizar o objeto de módulo fornecido no registro
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)	Atualizações o Gêmeo de um módulo específico com o patch fornecido.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	Atualizações o Dispositivo Gêmeo de um dispositivo específico com o patch fornecido.

Detalhes do método

addConfiguration(Configuration)

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

Parâmetros

configuration

Configuration

Retornos

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 a ser adicionada ao hub

done

HttpResponseCallback<any>

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

addDevices(DeviceDescription[])

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

Parâmetros

devices

DeviceDescription[]

Retornos

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 deve incluir uma deviceId propriedade cujo valor é um identificador de dispositivo válido.

done

HttpResponseCallback<BulkRegistryOperationResult>

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

addModule(Module)

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

Parâmetros

module

Module

Retornos

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

Adicione o módulo especificado ao registro.

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

Parâmetros

module

Module

Objeto module a ser adicionado ao registro.

done

HttpResponseCallback<any>

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

applyConfigurationContentOnDevice(string, ConfigurationContent)

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

Parâmetros

deviceId

string

content

ConfigurationContent

Retornos

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Aplicar a configuração fornecida a um dispositivo em um Hub IoT

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

Parâmetros

deviceId

string

ID do dispositivo ao qual aplicar a configuração

content

ConfigurationContent

A Configuração a ser aplicada

done

HttpResponseCallback<any>

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

cancelJob(string)

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

Parâmetros

jobId

string

Retornos

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

Cancelar um trabalho de importação/exportação em massa.

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

Parâmetros

jobId

string

O identificador do trabalho para o qual o usuário deseja obter informações de status.

done

Callback<JobStatus>

A função opcional a ser chamada com dois argumentos: um objeto de erro se um erro ocorreu, (caso contrário, nulo) e o status (cancelado) do trabalho cujo identificador foi passado como um argumento.

create(DeviceDescription)

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

Parâmetros

deviceInfo

DeviceDescription

Retornos

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

Cria uma nova identidade de dispositivo em um hub IoT.

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

Parâmetros

deviceInfo

DeviceDescription

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

done

HttpResponseCallback<Device>

A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um objeto Device que representa a identidade do dispositivo criada e um objeto de resposta específico do transporte útil para registro em log ou depuração.

createQuery(string, number)

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

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

Parâmetros

sqlQuery

string

A consulta gravada como uma cadeia de caracteres SQL.

pageSize

number

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

Retornos

Query

delete(string)

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

Parâmetros

deviceId

string

Retornos

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 ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um argumento always-null (para consistência com os outros métodos) e um objeto de resposta específico do transporte útil para registro em log ou depuração.

exportDevicesToBlob(string, boolean)

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

Parâmetros

outputBlobContainerUri

string

excludeKeys

boolean

Retornos

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Exportar dispositivos para um blob em um trabalho em massa.

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

Parâmetros

outputBlobContainerUri

string

O URI para um contêiner em que um blob chamado 'devices.txt' será criado contendo a lista de dispositivos.

excludeKeys

boolean

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

done

Callback<JobStatus>

A função opcional a ser chamada quando o trabalho foi criado, com dois argumentos: um objeto de erro se ocorreu um erro (caso contrário, nulo) e o status do trabalho que pode ser usado para acompanhar o progresso da exportação de dispositivos.

exportDevicesToBlobByIdentity(string, boolean)

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

Parâmetros

outputBlobContainerUri

string

excludeKeys

boolean

Retornos

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Exportar dispositivos para um blob em um trabalho em massa usando uma identidade configurada.

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

Parâmetros

outputBlobContainerUri

string

O URI para um contêiner em que um blob chamado 'devices.txt' será criado contendo a lista de dispositivos.

excludeKeys

boolean

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

done

Callback<JobStatus>

A função opcional a ser chamada quando o trabalho foi criado, com dois argumentos: um objeto de erro se ocorreu um erro (caso contrário, nulo) e o status do trabalho que pode ser usado para acompanhar o progresso da exportação de dispositivos.

exportDevicesToBlobByIdentity(string, boolean, string)

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

Parâmetros

outputBlobContainerUri

string

excludeKeys

boolean

userAssignedIdentity

string

Retornos

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 Registry a partir da cadeia de conexão fornecida.

static function fromConnectionString(value: string): Registry

Parâmetros

value

string

Uma cadeia de conexão que encapsula as permissões apropriadas (leitura e/ou gravação) do Registro.

Retornos

Registry

fromSharedAccessSignature(string)

Constrói um objeto registry a partir da assinatura de acesso compartilhado fornecida.

static function fromSharedAccessSignature(value: string): Registry

Parâmetros

value

string

Uma assinatura de acesso compartilhado que encapsula as permissões apropriadas (leitura e/ou gravação) do Registro.

Retornos

Registry

fromTokenCredential(string, TokenCredential)

Constrói um objeto registry do TokenCredential do Azure fornecido.

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

Parâmetros

hostName

string

Nome do host do serviço do Azure.

tokenCredential

TokenCredential

Um Tokencredential do Azure usado para autenticar com o serviço do Azure

Retornos

Registry

get(string)

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

Parâmetros

deviceId

string

Retornos

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

Solicita informações sobre uma identidade de dispositivo existente em um 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 ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um objeto Device que representa a identidade do dispositivo criada e um objeto de resposta específico do transporte útil para registro em log ou depuração.

getConfiguration(string)

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

Parâmetros

configurationId

string

Retornos

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

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

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

Parâmetros

configurationId

string

A ID da configuração com a qual você deve recuperar

done

HttpResponseCallback<Configuration>

O retorno de chamada opcional que será chamado com um objeto Error ou um module:azure-iothub. Objeto de configuração com os detalhes da configuração.

getConfigurations()

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

Retornos

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

Obter todas as configurações em um Hub IoT

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

Parâmetros

done

HttpResponseCallback<Configuration[]>

O retorno de chamada opcional que será chamado com um objeto Error ou uma matriz de module:azure-iothub. Objetos de configuração para todas as configurações.

getJob(string)

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

Parâmetros

jobId

string

Retornos

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

Obtenha o status de um trabalho de importação/exportação em massa.

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

Parâmetros

jobId

string

O identificador do trabalho para o qual o usuário deseja obter informações de status.

done

Callback<JobStatus>

A função opcional a ser chamada com dois argumentos: um objeto de erro se ocorreu um erro (caso contrário, nulo) e o status do trabalho cujo identificador foi passado como um argumento.

getModule(string, string)

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

Parâmetros

deviceId

string

moduleId

string

Retornos

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

Obter um único módulo de um dispositivo em um Hub IoT

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

Parâmetros

deviceId

string

ID do dispositivo que possui o módulo.

moduleId

string

ID do módulo a ser recuperado

done

HttpResponseCallback<Module>

O retorno de chamada opcional que será chamado com um objeto Error ou o module:azure-iothub. Objeto module para o módulo solicitado

getModulesOnDevice(string)

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

Parâmetros

deviceId

string

Retornos

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

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

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

Parâmetros

deviceId

string

ID do dispositivo para o qual estamos obtendo módulos

done

HttpResponseCallback<Module[]>

O retorno de chamada opcional que será chamado com um objeto Error ou uma matriz de module: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

Retornos

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

Obtém o Módulo Gêmeo 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 de módulo.

done

HttpResponseCallback<Twin>

O retorno de chamada opcional que será chamado com um objeto Error ou a instância do módulo gêmeo.

getRegistryStatistics()

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

Retornos

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

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

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Parâmetros

done

HttpResponseCallback<RegistryStatistics>

O retorno de chamada opcional que será chamado com um objeto Error ou as estatísticas do registro do dispositivo.

getTwin(string)

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

Parâmetros

deviceId

string

Retornos

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

Obtém o Dispositivo Gêmeo 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>

O retorno de chamada opcional que será chamado com um objeto Error ou a instância do dispositivo gêmeo.

importDevicesFromBlob(string, string)

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

Parâmetros

inputBlobContainerUri

string

outputBlobContainerUri

string

Retornos

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

Importa dispositivos de um blob no trabalho em massa.

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

Parâmetros

inputBlobContainerUri

string

O URI para um contêiner com um blob chamado 'devices.txt' que contém uma lista de dispositivos a serem importados.

outputBlobContainerUri

string

O URI para um contêiner em que um blob será criado com logs do processo de importação.

done

Callback<JobStatus>

A função opcional a ser chamada quando o trabalho foi criado, com dois argumentos: um objeto de erro se ocorreu um erro ( caso contrário, nulo) e o status do trabalho que pode ser usado para acompanhar o progresso da importação de dispositivos.

importDevicesFromBlobByIdentity(string, string)

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

Parâmetros

inputBlobContainerUri

string

outputBlobContainerUri

string

Retornos

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

Importa dispositivos de um blob no trabalho em massa usando uma identidade configurada.

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

Parâmetros

inputBlobContainerUri

string

O URI para um contêiner com um blob chamado 'devices.txt' que contém uma lista de dispositivos a serem importados.

outputBlobContainerUri

string

O URI para um contêiner em que um blob será criado com logs do processo de importação.

done

Callback<JobStatus>

A função opcional a ser chamada quando o trabalho foi criado, com dois argumentos: um objeto de erro se ocorreu um erro ( caso contrário, nulo) e o status do trabalho que pode ser usado para acompanhar 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

Retornos

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[]>>

Retornos

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

Solicita informações sobre as primeiras 1000 identidades de dispositivo em um hub IoT.

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

Parâmetros

done

HttpResponseCallback<Device[]>

A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), uma matriz de objetos Device que representam as identidades de dispositivo listadas e um objeto de resposta específico do transporte útil para registro em log ou depuração.

listJobs()

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

Retornos

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

Liste os últimos trabalhos de importação/exportação (incluindo o ativo, se houver).

function listJobs(done?: HttpResponseCallback<any>)

Parâmetros

done

HttpResponseCallback<any>

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

removeConfiguration(string)

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

Parâmetros

configurationId

string

Retornos

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

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

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

Parâmetros

configurationId

string

ID da configuração a ser removida

done

HttpResponseCallback<any>

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

removeDevices(DeviceDescription[], boolean)

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

Parâmetros

devices

DeviceDescription[]

forceRemove

boolean

Retornos

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 deve incluir uma deviceId propriedade cujo valor é um identificador de dispositivo válido.

forceRemove

boolean

se forceRemove for true, o dispositivo será removido independentemente de uma etag. Caso contrário, as etags devem corresponder.

done

HttpResponseCallback<BulkRegistryOperationResult>

A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um BulkRegistryOperationResult e um objeto de resposta específico do transporte úteis para registro em log ou depuração.

removeModule(Module, TripleValueCallback<any, any>)

Remover o módulo especificado do registro

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

Parâmetros

module

Module

done

TripleValueCallback<any, any>

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

removeModule(string | Module)

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

Parâmetros

moduleOrDeviceId

string | Module

Retornos

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string)

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

Parâmetros

moduleOrDeviceId

string | Module

moduleId

string

Retornos

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

Retornos

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

Atualizações uma identidade de dispositivo existente em um hub IoT com as informações de dispositivo fornecidas. O deviceInfo parâmetro deve incluir todas as propriedades atualizáveis. Por exemplo, se atualizar a status propriedade de disabled para enabled, o deviceInfo objeto também deverá ter o statusReason, autenticação (e suas subpropriedades), funcionalidades e deviceScope definidos para os valores atuais dos dispositivos ou essas propriedades serão redefinidas. É recomendável que a aPI get seja chamada primeiro antes de fazer uma atualização.

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

Parâmetros

deviceInfo

DeviceDescription

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

done

HttpResponseCallback<Device>

A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um objeto Device que representa a identidade do dispositivo atualizada e um objeto de resposta específico do transporte útil para registro em log ou depuração.

updateConfiguration(Configuration)

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

Parâmetros

configuration

Configuration

Retornos

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean)

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

Parâmetros

configuration

Configuration

forceUpdate

boolean

Retornos

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 em um hub IoT

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

Parâmetros

configuration

Configuration

Um objeto do tipo module:azure-iothub. Configuração a ser adicionada ao hub

done

HttpResponseCallback<any>

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

updateDevices(DeviceDescription[], boolean)

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

Parâmetros

devices

DeviceDescription[]

forceUpdate

boolean

Retornos

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Atualizações uma matriz de dispositivos. Os elementos individuais do devices parâmetro devem incluir todas as propriedades atualizáveis. Por exemplo, se atualizar a status propriedade de disabled para enabled, o objeto também deverá ter o statusReason, autenticação (e suas subpropriedades), funcionalidades e deviceScope definidos para os valores atuais dos dispositivos ou essas propriedades serão redefinidas. É recomendável que a aPI get seja chamada primeiro antes de fazer uma atualização.

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

Parâmetros

devices

DeviceDescription[]

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

forceUpdate

boolean

se forceUpdate for true, o dispositivo será atualizado independentemente de uma etag. Caso contrário, as etags devem corresponder.

done

HttpResponseCallback<BulkRegistryOperationResult>

A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um BulkRegistryOperationResult e um objeto de resposta específico do transporte úteis para registro em log ou depuração.

updateModule(Module)

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

Parâmetros

module

Module

Retornos

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean)

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

Parâmetros

module

Module

forceUpdate

boolean

Retornos

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 fornecido no registro

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

Parâmetros

module

Module

Objeto module a ser atualizado.

done

TripleValueCallback<any, any>

A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), o corpo da resposta e um objeto de resposta específico do transporte útil para registro em log 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

Retornos

Promise<ResultWithHttpResponse<Twin>>

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

Atualizações o Gêmeo de um módulo específico com o patch fornecido.

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 marcas desejadas para corrigir o módulo gêmeo.

etag

string

A etag mais recente deste módulo gêmeo ou '*' para forçar uma atualização mesmo que o módulo gêmeo tenha sido atualizado desde que a etag foi obtida.

done

HttpResponseCallback<Twin>

O retorno de chamada opcional que será chamado com um objeto Error ou a instância do módulo gêmeo.

updateTwin(string, any, string)

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

Parâmetros

deviceId

string

patch

any

etag

string

Retornos

Promise<ResultWithHttpResponse<Twin>>

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

Atualizações o Dispositivo Gêmeo de um dispositivo específico com o patch fornecido.

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

Parâmetros

deviceId

string

O identificador do dispositivo.

patch

any

As propriedades e marcas desejadas para corrigir o dispositivo gêmeo com.

etag

string

A etag mais recente para este dispositivo gêmeo ou '*' para forçar uma atualização mesmo que o dispositivo gêmeo tenha sido atualizado desde que a etag foi obtida.

done

HttpResponseCallback<Twin>

O retorno de chamada opcional que será chamado com um objeto Error ou a instância do dispositivo gêmeo.