azure-iot-common package

Classes

Message	O objeto Message é usado para telemetria (dispositivo para nuvem) e comandos (nuvem para dispositivo) mensagens assíncronas entre o dispositivo e o serviço Hub IoT. É independente do transporte, o que significa que funciona da mesma forma sobre AMQP, MQTT e HTTP.
ArgumentError	Erro lançado quando um argumento é inválido.
ArgumentOutOfRangeError	Erro lançado quando um argumento tem um valor que está fora do intervalo admissível.
BadDeviceResponseError	Erro gerado quando um dispositivo envia uma resposta incorreta para uma chamada de método de dispositivo.
CloudToDeviceDetachedError	Erro gerado quando o recurso c2d parou de funcionar no nível de transporte, exigindo que o cliente tente iniciá-lo novamente.
DeviceAlreadyExistsError	Erro gerado quando o ID do dispositivo usado para a criação do dispositivo já existe no Registro de Identidade do Dispositivo.
DeviceMaximumQueueDepthExceededError	Erro lançado quando a fila de mensagens de um dispositivo está cheia.
DeviceMessageLockLostError	O erro gerado ao liquidar uma mensagem falha porque o token de bloqueio associado à mensagem é perdido.
DeviceMethodsDetachedError	Erro gerado quando o recurso de métodos de dispositivo parou de funcionar no nível de transporte, exigindo que o cliente tente iniciá-lo novamente.
DeviceNotFoundError	Erro gerado quando um dispositivo não pode ser encontrado no registro da instância do Hub IoT.
DeviceRegistrationFailedError	Erro gerado quando uma operação de registro DPS falha
DeviceTimeoutError	Erro lançado quando o dispositivo não processa a chamada de método a tempo.
FormatError	Erro gerado quando uma cadeia de caracteres que deveria ter uma formatação específica não está formatada corretamente.
GatewayTimeoutError	Erro gerado quando a instância do Hub IoT não processa a chamada do método de dispositivo a tempo.
InternalServerError	Erro lançado quando ocorreu um erro interno do servidor. Você pode ter encontrado um bug?
InvalidEtagError	Erro gerado quando o eTag especificado está formatado incorretamente ou desatualizado.
InvalidOperationError	Erro gerado quando uma operação é tentada, mas não é permitida.
IotHubNotFoundError	Erro lançado quando o hub IoT do Azure não foi encontrado.
IotHubQuotaExceededError	Erro lançado a cota do hub do Azure IoT foi excedida. As quotas são repostas periodicamente, esta operação terá de esperar até lá. Para saber mais sobre cotas, consulte cotas do Hub IoT do Azure e limitação
IoTHubSuspendedError	Erro gerado quando o Hub IoT foi suspenso.
JobNotFoundError	Erro lançado quando o trabalho com o identificador especificado não foi encontrado.
MessageTooLargeError	Erro lançado quando a mensagem enviada é muito grande: o tamanho máximo é de 256Kb.
NotConnectedError	Erro lançado quando o dispositivo é desconectado e a operação não pode ser concluída.
NotImplementedError	Erro gerado quando um recurso ainda não foi implementado, mas o espaço reservado está presente.
OperationCancelledError	Erro lançado quando qualquer operação (local ou remota) é cancelada
PreconditionFailedError	Erro lançado quando uma condição que deveria ter sido cumprida para executar uma operação não foi.
SecurityDeviceError	Erro gerado quando um dispositivo/driver de segurança de baixo nível falha.
ServiceUnavailableError	Erro gerado quando o serviço não está disponível. A operação deve ser repetida.
ThrottlingError	Erro gerado quando o Hub IoT é limitado devido à atividade excessiva. Para saber mais sobre cotas, consulte cotas do Hub IoT do Azure e limitação
TimeoutError	Erro lançado quando ocorre um tempo limite
TooManyDevicesError	Erro lançado quando o número máximo de dispositivos em um hub específico foi atingido.
TwinDetachedError	Erro lançado quando o recurso gêmeo parou de funcionar no nível de transporte, exigindo que o cliente tente iniciá-lo novamente.
TwinRequestError	Erro genérico lançado quando uma solicitação gêmea falha com um código de erro desconhecido.
UnauthorizedError	Erro lançado quando os parâmetros de conexão estão errados e o servidor recusou a conexão.
Connected	Resultado retornado quando um transporte é conectado com êxito.
Disconnected	Resultado retornado quando um transporte é desconectado com êxito.
MessageAbandoned	Resultado retornado quando uma mensagem foi abandonada com êxito.
MessageCompleted	Resultado retornado quando uma mensagem foi rejeitada com êxito.
MessageEnqueued	Resultado retornado quando uma mensagem foi enfileirada com êxito.
MessageRejected	Resultado retornado quando uma mensagem foi rejeitada com êxito.
SharedAccessSignatureUpdated	Resultado retornado quando um token SAS foi atualizado com êxito.
TransportConfigured	Resultado retornado quando um transporte é configurado com êxito.
ConnectionString	Descreve os parâmetros que permitem que um dispositivo ou aplicativo de nuvem se conecte a um hub IoT do Azure.
ExponentialBackOffWithJitter	Implementa um backoff exponencial com a estratégia de repetição de Jitter. A função para calcular o próximo intervalo é a seguinte (x é a xª tentativa): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)
NoRetry	Política de stub que bloqueia qualquer tentativa de repetição. As operações não são repetidas.
RetryOperation	Implementa a lógica necessária para repetir operações como conectar, receber mensagens C2D, enviar telemetria, atualizações gêmeas, etc.
SharedAccessSignature	Os tokens de assinatura de acesso compartilhado são usados para autenticar a conexão ao usar chaves simétricas (em oposição aos certificados x509) para proteger a conexão com o hub IoT do Azure.

Interfaces

AuthenticationProvider	Interface que deve ser implementada por objetos usados para fornecer credenciais aos transportes usados pelo cliente de dispositivo para autenticar com uma instância do hub IoT do Azure.
Receiver
RetryPolicy	Interface que descreve um objeto de política de nova tentativa. As políticas de repetição são compostas por 2 coisas Um algoritmo que calcula a próxima vez para tentar novamente com base no número atual ou nas tentativas. Um filtro de erro que decide, com base no tipo de erro recebido, se uma nova tentativa deve acontecer ou não. Esses 2 componentes se escondem atrás de 2 chamadas de método descritas nesta interface.
TransportConfig	Estrutura de configuração usada por transportes e objetos AuthenticationProvider para armazenar e trocar credenciais.
X509	Objeto usado para armazenar um certificado X509 e uma chave para os transportes usarem. Isso é passado diretamente para os objetos de baixo nível usados por Node.js para conectar o soquete TLS. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Aliases de Tipo

BufferConvertible
ResultWithHttpResponse
Callback	Define o tipo que descreve o retorno de chamada regular com dois resultados - um é o Erro, o outro é o valor do resultado.
DoubleValueCallback	Define o tipo que descreve o retorno de chamada com dois resultados.
ErrorCallback	Define o tipo que descreve o retorno de chamada apenas com o valor do resultado do erro.
HttpResponseCallback	Define o tipo que descreve o retorno de chamada com três resultados - resposta, resposta HTTP bruta e um erro.
NoErrorCallback	Define o tipo que descreve o retorno de chamada com um valor de resultado sem erro.
TripleValueCallback	Define o tipo que descreve o retorno de chamada regular com três resultados - o primeiro é Error, os outros dois são os valores de resultado.

Enumerações

AuthenticationType

Designe o tipo de autenticação usado por um AuthenticationProvider.

Funções

anHourFromNow()	Devolve os segundos decorridos desde 1 de janeiro de 1970 00:00:00 UTC até daqui a uma hora.
encodeUriComponentStrict(string)

Detalhes de Função

anHourFromNow()

Devolve os segundos decorridos desde 1 de janeiro de 1970 00:00:00 UTC até daqui a uma hora.

function anHourFromNow(): number

Devoluções

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Parâmetros

str

string

Devoluções

string