azure-iot-common package

Classes

Message	O Message objeto é usado para telemetria (dispositivo para nuvem) e comandos (nuvem para dispositivo) mensagens assíncronas entre o dispositivo e o serviço de Hub IoT. Ele é independente de transporte, o que significa que funciona da mesma maneira em AMQP, MQTT e HTTP.
ArgumentError	Erro gerado quando um argumento é inválido.
ArgumentOutOfRangeError	Erro gerado quando um argumento tem um valor 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 a ID do dispositivo usada para a criação do dispositivo já existe no Registro de Identidade do Dispositivo.
DeviceMaximumQueueDepthExceededError	Erro gerado quando a fila de mensagens de um dispositivo está cheia.
DeviceMessageLockLostError	O erro gerado ao resolver 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 de instância Hub IoT.
DeviceRegistrationFailedError	Erro gerado quando uma operação de registro DPS falha
DeviceTimeoutError	Erro gerado 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 de Hub IoT não processa a chamada de método do dispositivo a tempo.
InternalServerError	Erro gerado quando ocorreu um erro interno do servidor. Você pode ter encontrado um bug?
InvalidEtagError	Erro gerado quando a eTag especificada está formatada incorretamente ou desatualizada.
InvalidOperationError	Erro gerado quando uma operação é tentada, mas não é permitida.
IotHubNotFoundError	Erro gerado quando o hub IoT do Azure não foi encontrado.
IotHubQuotaExceededError	Erro ao gerar a cota do Hub IoT do Azure foi excedido. As cotas são redefinidas periodicamente, essa operação terá que aguardar até lá. Para saber mais sobre cotas, confira cotas Hub IoT do Azure e limitação
IoTHubSuspendedError	Erro gerado quando Hub IoT foi suspenso.
JobNotFoundError	Erro gerado quando o trabalho com o identificador especificado não foi encontrado.
MessageTooLargeError	Erro gerado quando a mensagem enviada é muito grande: o tamanho máximo é de 256 Kb.
NotConnectedError	Erro gerado quando o dispositivo está desconectado e a operação não pode ser concluída.
NotImplementedError	Erro gerado quando um recurso ainda não está implementado, mas o espaço reservado está presente.
OperationCancelledError	Erro gerado quando qualquer operação (local ou remota) é cancelada
PreconditionFailedError	Erro gerado quando uma condição que deveria ter sido atendida 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 Hub IoT é limitada devido a atividade excessiva. Para saber mais sobre cotas, confira cotas Hub IoT do Azure e limitação
TimeoutError	Erro gerado quando ocorre um tempo limite
TooManyDevicesError	Erro gerado quando o número máximo de dispositivos em um hub específico foi atingido.
TwinDetachedError	Erro gerado 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 gerado quando uma solicitação de gêmeo falha com um código de erro desconhecido.
UnauthorizedError	Erro gerado 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 uma retirada exponencial com estratégia de repetição de tremulação. A função para calcular o próximo intervalo é a seguinte (x é a xth retry): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)
NoRetry	Política stub que bloqueia qualquer tentativa provisória. As operações não são repetidas.
RetryOperation	Implementa a lógica necessária para repetir operações como conexão, recebimento de mensagens C2D, envio de telemetria, atualizações de gêmeos etc.
SharedAccessSignature	Os tokens de assinatura de acesso compartilhado são usados para autenticar a conexão ao usar chaves simétricas (em vez de certificados x509) para proteger a conexão com o hub IoT do Azure.

Interfaces

AuthenticationProvider	Interface que deve ser implementada por objetos que são usados para fornecer credenciais para os transportes usados pelo cliente do dispositivo para autenticar com uma instância do Hub IoT do Azure.
Receiver
RetryPolicy	Interface que descreve um objeto de política de repetição. As políticas de repetição são compostas por 2 itens Um algoritmo que calcula a próxima vez para tentar novamente com base no número atual ou novas tentativas. Um filtro de erro que decide, com base no tipo de erro recebido, se uma repetição deve acontecer ou não. Esses dois componentes se ocultam atrás de duas chamadas de método descritas nesta interface.
TransportConfig	Estrutura de configuração usada por transportes e AuthenticationProvider objetos para armazenar e trocar credenciais.
X509	Objeto usado para armazenar um certificado X509 e uma chave para transportes a serem usados. Isso é passado diretamente para os objetos de baixo nível usados pelo 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 com apenas 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()	Retorna os segundos decorridos desde 1º de janeiro de 1970 00:00:00 UTC até uma hora a partir de agora.
encodeUriComponentStrict(string)

Detalhes da função

anHourFromNow()

Retorna os segundos decorridos desde 1º de janeiro de 1970 00:00:00 UTC até uma hora a partir de agora.

function anHourFromNow(): number

Retornos

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Parâmetros

str

string

Retornos

string