다음을 통해 공유


azure-iot-common package

클래스

Message

개체는 Message 디바이스와 IoT Hub 서비스 간의 원격 분석(디바이스-클라우드) 및 명령(클라우드-디바이스) 비동기 메시징에 사용됩니다. 전송에 구애받지 않으므로 AMQP, MQTT 및 HTTP를 통해 동일한 방식으로 작동합니다.

ArgumentError

인수가 잘못되면 오류가 발생합니다.

ArgumentOutOfRangeError

인수에 허용되는 범위를 벗어난 값이 있으면 오류가 발생합니다.

BadDeviceResponseError

디바이스가 디바이스 메서드 호출에 잘못된 응답을 보낼 때 오류가 발생합니다.

CloudToDeviceDetachedError

c2d 기능이 전송 수준에서 작동을 중지하여 클라이언트가 다시 시작해야 할 때 오류가 발생했습니다.

DeviceAlreadyExistsError

디바이스를 만드는 데 사용된 디바이스 ID가 디바이스 ID 레지스트리에 이미 있는 경우 오류가 발생합니다.

DeviceMaximumQueueDepthExceededError

디바이스에 대한 메시지 큐가 가득 차면 오류가 발생합니다.

DeviceMessageLockLostError

메시지와 연결된 잠금 토큰이 손실되어 메시지 해결에 실패할 때 오류가 발생합니다.

DeviceMethodsDetachedError

디바이스 메서드 기능이 전송 수준에서 작동을 중지하여 클라이언트가 다시 시작해야 할 때 오류가 발생했습니다.

DeviceNotFoundError

IoT Hub instance 레지스트리에서 디바이스를 찾을 수 없을 때 오류가 발생했습니다.

DeviceRegistrationFailedError

DPS 등록 작업이 실패할 때 발생하는 오류

DeviceTimeoutError

디바이스가 메서드 호출을 적시에 처리하지 않을 때 오류가 발생합니다.

FormatError

특정 서식이 있어야 하는 문자열의 서식이 제대로 지정되지 않은 경우 오류가 발생합니다.

GatewayTimeoutError

IoT Hub instance 시간 안에 디바이스 메서드 호출을 처리하지 않을 때 오류가 발생합니다.

InternalServerError

내부 서버 오류가 발생했을 때 오류가 발생했습니다. 버그를 발견했나요?

InvalidEtagError

지정된 eTag의 형식이 잘못되었거나 오래된 경우 오류가 발생합니다.

InvalidOperationError

작업을 시도했지만 허용되지 않을 때 오류가 발생합니다.

IotHubNotFoundError

Azure IoT Hub를 찾을 수 없을 때 오류가 발생했습니다.

IotHubQuotaExceededError

Azure IoT Hub 할당량이 초과되었습니다. 할당량은 주기적으로 다시 설정되며, 이 작업은 그때까지 기다려야 합니다. 할당량에 대한 자세한 내용은 할당량 및 제한 Azure IoT Hub 참조하세요.

IoTHubSuspendedError

IoT Hub 일시 중단되었을 때 오류가 발생합니다.

JobNotFoundError

지정된 식별자를 가진 작업을 찾을 수 없을 때 오류가 발생했습니다.

MessageTooLargeError

보낸 메시지가 너무 크면 오류가 발생합니다. 최대 크기는 256Kb입니다.

NotConnectedError

디바이스 연결이 끊어지고 작업을 완료할 수 없을 때 오류가 발생합니다.

NotImplementedError

기능이 아직 구현되지 않았지만 자리 표시자가 있는 경우 오류가 발생합니다.

OperationCancelledError

모든 작업(로컬 또는 원격)이 취소될 때 발생하는 오류

PreconditionFailedError

작업을 실행하기 위해 충족해야 하는 조건이 충족되지 않은 경우 오류가 throw되었습니다.

SecurityDeviceError

낮은 수준의 보안 디바이스/드라이버가 실패할 때 오류가 발생합니다.

ServiceUnavailableError

서비스를 사용할 수 없을 때 오류가 발생했습니다. 작업을 다시 시도해야 합니다.

ThrottlingError

과도한 작업으로 인해 IoT Hub 제한될 때 발생하는 오류입니다. 할당량에 대한 자세한 내용은 할당량 및 제한 Azure IoT Hub 참조하세요.

TimeoutError

시간 제한이 발생할 때 발생하는 오류

TooManyDevicesError

특정 허브의 최대 디바이스 수에 도달하면 오류가 발생합니다.

TwinDetachedError

쌍 기능이 전송 수준에서 작동을 중지하여 클라이언트가 다시 시작해야 할 때 오류가 발생했습니다.

TwinRequestError

트윈 요청이 알 수 없는 오류 코드와 함께 실패할 때 발생하는 일반 오류입니다.

UnauthorizedError

연결 매개 변수가 잘못되었고 서버에서 연결을 거부했을 때 오류가 발생했습니다.

Connected

전송이 성공적으로 연결되면 반환되는 결과입니다.

Disconnected

전송 연결이 성공적으로 끊어지면 결과가 반환됩니다.

MessageAbandoned

메시지가 성공적으로 중단되었을 때 반환된 결과입니다.

MessageCompleted

메시지가 성공적으로 거부되었을 때 반환된 결과입니다.

MessageEnqueued

메시지가 성공적으로 큐에 추가되었을 때 반환된 결과입니다.

MessageRejected

메시지가 성공적으로 거부되었을 때 반환된 결과입니다.

SharedAccessSignatureUpdated

SAS 토큰이 성공적으로 업데이트되었을 때 반환된 결과입니다.

TransportConfigured

전송이 성공적으로 구성되면 반환되는 결과입니다.

ConnectionString

디바이스 또는 클라우드 애플리케이션이 Azure IoT Hub에 연결할 수 있도록 하는 매개 변수에 대해 설명합니다.

ExponentialBackOffWithJitter

지터 재시도 전략을 사용하여 지수 백오프를 구현합니다. 다음 간격을 계산하는 함수는 다음과 같습니다(x는 x번째 재시도임): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)

NoRetry

재시도 미정을 차단하는 스텁 정책입니다. 작업은 다시 시도되지 않습니다.

RetryOperation

연결, C2D 메시지 수신, 원격 분석 전송, 트윈 업데이트 등과 같은 작업을 다시 시도하는 데 필요한 논리를 구현합니다.

SharedAccessSignature

공유 액세스 서명 토큰은 대칭 키(x509 인증서가 아닌)를 사용하여 Azure IoT Hub와의 연결을 보호할 때 연결을 인증하는 데 사용됩니다.

인터페이스

AuthenticationProvider

Azure IoT Hub instance 인증하기 위해 디바이스 클라이언트에서 사용하는 전송에 자격 증명을 제공하는 데 사용되는 개체에서 구현해야 하는 인터페이스입니다.

Receiver
RetryPolicy

재시도 정책 개체를 설명하는 인터페이스입니다. 재시도 정책은 2가지로 구성됩니다.

  • 현재 수 또는 재시도에 따라 다음번에 다시 시도하도록 계산하는 알고리즘입니다.
  • 수신된 오류 유형에 따라 재시도 여부를 결정하는 오류 필터입니다.

이러한 2개 구성 요소는 이 인터페이스에 설명된 2개의 메서드 호출 뒤에 숨깁니다.

TransportConfig

전송 및 AuthenticationProvider 개체에서 자격 증명을 저장하고 교환하는 데 사용되는 구성 구조입니다.

X509

전송에서 사용할 X509 인증서 및 키를 저장하는 데 사용되는 개체입니다.

이는 TLS 소켓을 연결하는 데 Node.js 사용하는 하위 수준 개체로 직접 전달됩니다. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

형식 별칭

BufferConvertible
ResultWithHttpResponse
Callback

두 개의 결과가 있는 일반 콜백을 설명하는 형식을 정의합니다. 하나는 오류이고 다른 하나는 결과 값입니다.

DoubleValueCallback

두 개의 결과를 사용하여 콜백을 설명하는 형식을 정의합니다.

ErrorCallback

오류 결과 값만 사용하여 콜백을 설명하는 형식을 정의합니다.

HttpResponseCallback

응답, 원시 HTTP 응답 및 오류의 세 가지 결과를 사용하여 콜백을 설명하는 형식을 정의합니다.

NoErrorCallback

오류가 아닌 결과 값이 하나 있는 콜백을 설명하는 형식을 정의합니다.

TripleValueCallback

세 개의 결과가 있는 일반 콜백을 설명하는 형식을 정의합니다. 첫 번째 콜백은 오류이고 다른 두 가지는 결과 값입니다.

열거형

AuthenticationType

에서 사용하는 인증 유형을 지정합니다 AuthenticationProvider.

함수

anHourFromNow()

1970년 1월 1일 00:00:00 UTC 이후부터 1시간까지 경과된 초를 반환합니다.

encodeUriComponentStrict(string)

함수 세부 정보

anHourFromNow()

1970년 1월 1일 00:00:00 UTC 이후부터 1시간까지 경과된 초를 반환합니다.

function anHourFromNow(): number

반환

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

매개 변수

str

string

반환

string