Registry class
레지스트리 클래스는 IoT Hub 디바이스 ID 서비스에 대한 액세스를 제공합니다. SDK 사용자는 팩터리 메서드 중 하나인 fromConnectionString 또는 fromSharedAccessSignature를 사용하여 이 클래스를 인스턴스화해야 합니다.
디바이스 ID 레지스트리 작업에 사용되는 프로토콜은 HTTPS입니다.
메서드
메서드 세부 정보
addConfiguration(Configuration)
function addConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>매개 변수
- configuration
- Configuration
반환
Promise<ResultWithHttpResponse<any>>
addConfiguration(Configuration, HttpResponseCallback<any>)
IoT Hub에 구성을 추가합니다.
function addConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)매개 변수
- configuration
- Configuration
module:azure-iothub 형식의 개체입니다. 허브에 추가할 구성
- done
-
HttpResponseCallback<any>
작업이 완료된 경우 호출할 선택적 함수입니다. done 는 Error 개체(null일 수 있음), 응답 본문 및 로깅 또는 디버깅에 유용한 전송별 응답 개체의 세 가지 인수를 사용하여 호출됩니다.
addDevices(DeviceDescription[])
function addDevices(devices: DeviceDescription[]): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>매개 변수
- devices
반환
Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)
디바이스 배열을 추가합니다.
function addDevices(devices: DeviceDescription[], done?: HttpResponseCallback<BulkRegistryOperationResult>)매개 변수
- devices
값이 유효한 디바이스 식별자인 deviceId 속성을 포함해야 하는 개체의 배열입니다.
- done
-
HttpResponseCallback<BulkRegistryOperationResult>
작업이 완료된 경우 호출할 선택적 함수입니다. done 는 Error 개체(null일 수 있음), BulkRegistryOperationResult 및 로깅 또는 디버깅에 유용한 전송별 응답 개체의 세 가지 인수를 사용하여 호출됩니다.
addModule(Module)
function addModule(module: Module): Promise<ResultWithHttpResponse<any>>매개 변수
- module
- Module
반환
Promise<ResultWithHttpResponse<any>>
addModule(Module, HttpResponseCallback<any>)
지정된 모듈을 레지스트리에 추가합니다.
function addModule(module: Module, done?: HttpResponseCallback<any>)매개 변수
- module
- Module
레지스트리에 추가할 모듈 개체입니다.
- done
-
HttpResponseCallback<any>
작업이 완료된 경우 호출할 선택적 함수입니다. done 는 Error 개체(null일 수 있음), 응답 본문 및 로깅 또는 디버깅에 유용한 전송별 응답 개체의 세 가지 인수를 사용하여 호출됩니다.
applyConfigurationContentOnDevice(string, ConfigurationContent)
function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent): Promise<ResultWithHttpResponse<any>>매개 변수
- deviceId
-
string
- content
- ConfigurationContent
반환
Promise<ResultWithHttpResponse<any>>
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)
지정된 구성을 IoT Hub 디바이스에 적용
function applyConfigurationContentOnDevice(deviceId: string, content: ConfigurationContent, done?: HttpResponseCallback<any>)매개 변수
- deviceId
-
string
구성을 적용할 디바이스의 ID
- content
- ConfigurationContent
적용할 구성
- done
-
HttpResponseCallback<any>
작업이 완료된 경우 호출할 선택적 함수입니다. done 은 Error 개체(null일 수 있음), 응답 본문 및 로깅 또는 디버깅에 유용한 전송별 응답 개체의 세 가지 인수를 사용하여 호출됩니다.
cancelJob(string)
cancelJob(string, Callback<JobStatus>)
대량 가져오기/내보내기 작업을 취소합니다.
function cancelJob(jobId: string, done?: Callback<JobStatus>)매개 변수
- jobId
-
string
사용자가 상태 정보를 가져올 작업의 식별자입니다.
- done
-
Callback<JobStatus>
두 인수를 사용하여 호출할 선택적 함수: 오류가 발생한 경우 오류 개체, (그렇지 않으면 null) 및 식별자가 인수로 전달된 작업의 (취소됨) 상태입니다.
create(DeviceDescription)
function create(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>매개 변수
- deviceInfo
- DeviceDescription
반환
Promise<ResultWithHttpResponse<Device>>
create(DeviceDescription, HttpResponseCallback<Device>)
IoT Hub에 새 디바이스 ID를 만듭니다.
function create(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)매개 변수
- deviceInfo
- DeviceDescription
개체에는 유효한 디바이스 식별자가 있는 deviceId 속성이 포함되어야 합니다.
createQuery(string, number)
IoT Hub 인스턴스에서 실행하여 디바이스 또는 작업에 대한 정보를 찾을 수 있는 쿼리를 만듭니다.
function createQuery(sqlQuery: string, pageSize?: number): Query매개 변수
- sqlQuery
-
string
SQL 문자열로 작성된 쿼리입니다.
- pageSize
-
number
페이지당 원하는 결과 수입니다(선택 사항. 기본값: 1000, 최대: 10000).
반환
Query
delete(string)
function delete(deviceId: string): Promise<ResultWithHttpResponse<any>>매개 변수
- deviceId
-
string
반환
Promise<ResultWithHttpResponse<any>>
delete(string, HttpResponseCallback<any>)
IoT Hub에서 기존 디바이스 ID를 제거합니다.
function delete(deviceId: string, done?: HttpResponseCallback<any>)매개 변수
- deviceId
-
string
기존 디바이스 ID의 식별자입니다.
- done
-
HttpResponseCallback<any>
작업이 완료된 경우 호출할 선택적 함수입니다. done 은 Error 개체(null일 수 있음), always-null 인수(다른 메서드와의 일관성을 위해) 및 로깅 또는 디버깅에 유용한 전송별 응답 개체의 세 가지 인수를 사용하여 호출됩니다.
exportDevicesToBlob(string, boolean)
function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>매개 변수
- outputBlobContainerUri
-
string
- excludeKeys
-
boolean
반환
Promise<JobStatus>
exportDevicesToBlob(string, boolean, Callback<JobStatus>)
대량 작업에서 디바이스를 Blob으로 내보냅니다.
function exportDevicesToBlob(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)매개 변수
- outputBlobContainerUri
-
string
디바이스 목록을 포함하는 'devices.txt'이라는 Blob이 만들어지는 컨테이너에 대한 URI입니다.
- excludeKeys
-
boolean
내보낸 데이터에서 보안 키를 제외해야 하는지 여부를 나타내는 부울입니다.
- done
-
Callback<JobStatus>
작업이 생성될 때 호출할 선택적 함수로, 오류가 발생한 경우 오류 개체( 그렇지 않으면 null) 및 디바이스 내보내기의 진행률을 추적하는 데 사용할 수 있는 작업 상태라는 두 개의 인수를 사용합니다.
exportDevicesToBlobByIdentity(string, boolean)
function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean): Promise<JobStatus>매개 변수
- outputBlobContainerUri
-
string
- excludeKeys
-
boolean
반환
Promise<JobStatus>
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)
구성된 ID를 사용하여 대량 작업의 Blob으로 디바이스를 내보냅니다.
function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, done?: Callback<JobStatus>)매개 변수
- outputBlobContainerUri
-
string
디바이스 목록을 포함하는 'devices.txt'이라는 Blob이 만들어지는 컨테이너에 대한 URI입니다.
- excludeKeys
-
boolean
내보낸 데이터에서 보안 키를 제외해야 하는지 여부를 나타내는 부울입니다.
- done
-
Callback<JobStatus>
작업이 생성될 때 호출할 선택적 함수로, 오류가 발생한 경우 오류 개체( 그렇지 않으면 null) 및 디바이스 내보내기의 진행률을 추적하는 데 사용할 수 있는 작업 상태라는 두 개의 인수를 사용합니다.
exportDevicesToBlobByIdentity(string, boolean, string)
function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string): Promise<JobStatus>매개 변수
- outputBlobContainerUri
-
string
- excludeKeys
-
boolean
- userAssignedIdentity
-
string
반환
Promise<JobStatus>
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
function exportDevicesToBlobByIdentity(outputBlobContainerUri: string, excludeKeys: boolean, userAssignedIdentity: string, done: Callback<JobStatus>)매개 변수
- outputBlobContainerUri
-
string
- excludeKeys
-
boolean
- userAssignedIdentity
-
string
- done
-
Callback<JobStatus>
fromConnectionString(string)
지정된 연결 문자열에서 Registry 개체를 생성합니다.
static function fromConnectionString(value: string): Registry매개 변수
- value
-
string
적절한(읽기 및/또는 쓰기) 레지스트리 권한을 캡슐화하는 연결 문자열입니다.
반환
fromSharedAccessSignature(string)
지정된 공유 액세스 서명에서 Registry 개체를 생성합니다.
static function fromSharedAccessSignature(value: string): Registry매개 변수
- value
-
string
적절한(읽기 및/또는 쓰기) 레지스트리 권한을 캡슐화하는 공유 액세스 서명입니다.
반환
fromTokenCredential(string, TokenCredential)
지정된 Azure TokenCredential에서 Registry 개체를 생성합니다.
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): Registry매개 변수
- hostName
-
string
Azure 서비스의 호스트 이름입니다.
- tokenCredential
- TokenCredential
Azure 서비스로 인증하는 데 사용되는 Azure TokenCredential
반환
get(string)
function get(deviceId: string): Promise<ResultWithHttpResponse<Device>>매개 변수
- deviceId
-
string
반환
Promise<ResultWithHttpResponse<Device>>
get(string, HttpResponseCallback<Device>)
IoT Hub에서 기존 디바이스 ID에 대한 정보를 요청합니다.
function get(deviceId: string, done?: HttpResponseCallback<Device>)매개 변수
- deviceId
-
string
기존 디바이스 ID의 식별자입니다.
getConfiguration(string)
function getConfiguration(configurationId: string): Promise<ResultWithHttpResponse<Configuration>>매개 변수
- configurationId
-
string
반환
Promise<ResultWithHttpResponse<Configuration>>
getConfiguration(string, HttpResponseCallback<Configuration>)
IoT Hub 단일 구성 가져오기
function getConfiguration(configurationId: string, done?: HttpResponseCallback<Configuration>)매개 변수
- configurationId
-
string
검색할 구성의 ID입니다.
- done
-
HttpResponseCallback<Configuration>
Error 개체 또는 module:azure-iothub를 사용하여 호출될 선택적 콜백입니다. 구성 세부 정보가 있는 구성 개체입니다.
getConfigurations()
function getConfigurations(): Promise<ResultWithHttpResponse<Configuration[]>>반환
Promise<ResultWithHttpResponse<Configuration[]>>
getConfigurations(HttpResponseCallback<Configuration[]>)
IoT Hub 모든 구성 가져오기
function getConfigurations(done?: HttpResponseCallback<Configuration[]>)매개 변수
- done
-
HttpResponseCallback<Configuration[]>
Error 개체 또는 module:azure-iothub 배열을 사용하여 호출되는 선택적 콜백입니다. 모든 구성에 대한 구성 개체입니다.
getJob(string)
getJob(string, Callback<JobStatus>)
대량 가져오기/내보내기 작업의 상태를 가져옵니다.
function getJob(jobId: string, done?: Callback<JobStatus>)매개 변수
- jobId
-
string
사용자가 상태 정보를 가져올 작업의 식별자입니다.
- done
-
Callback<JobStatus>
두 인수를 사용하여 호출할 선택적 함수입니다. 오류가 발생한 경우 오류 개체( 그렇지 않으면 null) 및 식별자가 인수로 전달된 작업의 상태입니다.
getModule(string, string)
function getModule(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Module>>매개 변수
- deviceId
-
string
- moduleId
-
string
반환
Promise<ResultWithHttpResponse<Module>>
getModule(string, string, HttpResponseCallback<Module>)
IoT Hub 디바이스에서 단일 모듈 가져오기
function getModule(deviceId: string, moduleId: string, done?: HttpResponseCallback<Module>)매개 변수
- deviceId
-
string
모듈을 소유하는 디바이스 ID입니다.
- moduleId
-
string
검색할 모듈 ID
- done
-
HttpResponseCallback<Module>
Error 개체 또는 module:azure-iothub를 사용하여 호출될 선택적 콜백입니다. 요청된 모듈에 대한 모듈 개체
getModulesOnDevice(string)
function getModulesOnDevice(deviceId: string): Promise<ResultWithHttpResponse<Module[]>>매개 변수
- deviceId
-
string
반환
Promise<ResultWithHttpResponse<Module[]>>
getModulesOnDevice(string, HttpResponseCallback<Module[]>)
IoT Hub 디바이스의 모든 모듈 목록 가져오기
function getModulesOnDevice(deviceId: string, done?: HttpResponseCallback<Module[]>)매개 변수
- deviceId
-
string
모듈을 가져오는 디바이스의 ID
- done
-
HttpResponseCallback<Module[]>
Error 개체 또는 module:azure-iothub 배열을 사용하여 호출되는 선택적 콜백입니다. 모든 모듈에 대한 모듈 개체입니다.
getModuleTwin(string, string)
function getModuleTwin(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Twin>>매개 변수
- deviceId
-
string
- moduleId
-
string
반환
Promise<ResultWithHttpResponse<Twin>>
getModuleTwin(string, string, HttpResponseCallback<Twin>)
지정된 모듈 식별자를 사용하여 모듈의 모듈 쌍을 가져옵니다.
function getModuleTwin(deviceId: string, moduleId: string, done?: HttpResponseCallback<Twin>)매개 변수
- deviceId
-
string
디바이스 식별자입니다.
- moduleId
-
string
모듈 식별자입니다.
- done
-
HttpResponseCallback<Twin>
Error 개체 또는 모듈 쌍 인스턴스를 사용하여 호출될 선택적 콜백입니다.
getRegistryStatistics()
function getRegistryStatistics(): Promise<ResultWithHttpResponse<RegistryStatistics>>반환
Promise<ResultWithHttpResponse<RegistryStatistics>>
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)
디바이스 ID 레지스트리의 디바이스에 대한 통계를 가져옵니다.
function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)매개 변수
- done
-
HttpResponseCallback<RegistryStatistics>
Error 개체 또는 디바이스 레지스트리 통계를 사용하여 호출될 선택적 콜백입니다.
getTwin(string)
function getTwin(deviceId: string): Promise<ResultWithHttpResponse<Twin>>매개 변수
- deviceId
-
string
반환
Promise<ResultWithHttpResponse<Twin>>
getTwin(string, HttpResponseCallback<Twin>)
지정된 디바이스 식별자를 사용하여 디바이스의 디바이스 쌍을 가져옵니다.
function getTwin(deviceId: string, done?: HttpResponseCallback<Twin>)매개 변수
- deviceId
-
string
디바이스 식별자입니다.
- done
-
HttpResponseCallback<Twin>
Error 개체 또는 디바이스 쌍 인스턴스를 사용하여 호출될 선택적 콜백입니다.
importDevicesFromBlob(string, string)
function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>매개 변수
- inputBlobContainerUri
-
string
- outputBlobContainerUri
-
string
반환
Promise<JobStatus>
importDevicesFromBlob(string, string, Callback<JobStatus>)
대량 작업의 Blob에서 디바이스를 가져옵니다.
function importDevicesFromBlob(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)매개 변수
- inputBlobContainerUri
-
string
가져올 디바이스 목록이 포함된 'devices.txt'라는 Blob이 있는 컨테이너에 대한 URI입니다.
- outputBlobContainerUri
-
string
가져오기 프로세스의 로그를 사용하여 Blob을 만들 컨테이너에 대한 URI입니다.
- done
-
Callback<JobStatus>
작업이 생성될 때 호출할 선택적 함수로, 오류가 발생한 경우 오류 개체( 그렇지 않으면 null) 및 디바이스 가져오기의 진행률을 추적하는 데 사용할 수 있는 작업 상태라는 두 개의 인수를 사용합니다.
importDevicesFromBlobByIdentity(string, string)
function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string): Promise<JobStatus>매개 변수
- inputBlobContainerUri
-
string
- outputBlobContainerUri
-
string
반환
Promise<JobStatus>
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)
구성된 ID를 사용하여 대량 작업의 Blob에서 디바이스를 가져옵니다.
function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, done?: Callback<JobStatus>)매개 변수
- inputBlobContainerUri
-
string
가져올 디바이스 목록이 포함된 'devices.txt'라는 Blob이 있는 컨테이너에 대한 URI입니다.
- outputBlobContainerUri
-
string
가져오기 프로세스의 로그를 사용하여 Blob을 만들 컨테이너에 대한 URI입니다.
- done
-
Callback<JobStatus>
작업이 생성될 때 호출할 선택적 함수로, 오류가 발생한 경우 오류 개체( 그렇지 않으면 null) 및 디바이스 가져오기의 진행률을 추적하는 데 사용할 수 있는 작업 상태라는 두 개의 인수를 사용합니다.
importDevicesFromBlobByIdentity(string, string, string)
function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string): Promise<JobStatus>매개 변수
- inputBlobContainerUri
-
string
- outputBlobContainerUri
-
string
- userAssignedIdentity
-
string
반환
Promise<JobStatus>
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
function importDevicesFromBlobByIdentity(inputBlobContainerUri: string, outputBlobContainerUri: string, userAssignedIdentity: string, done: Callback<JobStatus>)매개 변수
- inputBlobContainerUri
-
string
- outputBlobContainerUri
-
string
- userAssignedIdentity
-
string
- done
-
Callback<JobStatus>
list()
function list(): Promise<ResultWithHttpResponse<Device[]>>반환
Promise<ResultWithHttpResponse<Device[]>>
list(HttpResponseCallback<Device[]>)
IoT Hub에서 처음 1000개의 디바이스 ID에 대한 정보를 요청합니다.
function list(done?: HttpResponseCallback<Device[]>)매개 변수
listJobs()
function listJobs(): Promise<ResultWithHttpResponse<any>>반환
Promise<ResultWithHttpResponse<any>>
listJobs(HttpResponseCallback<any>)
마지막 가져오기/내보내기 작업(활성 작업(있는 경우 포함)을 나열합니다.
function listJobs(done?: HttpResponseCallback<any>)매개 변수
- done
-
HttpResponseCallback<any>
두 인수를 사용하여 호출할 선택적 함수: 오류가 발생한 경우 오류 개체, (그렇지 않으면 null) 및 과거 작업 목록을 인수로 사용합니다.
removeConfiguration(string)
function removeConfiguration(configurationId: string): Promise<ResultWithHttpResponse<any>>매개 변수
- configurationId
-
string
반환
Promise<ResultWithHttpResponse<any>>
removeConfiguration(string, HttpResponseCallback<any>)
IoT Hub 지정된 ID가 있는 구성을 제거합니다.
function removeConfiguration(configurationId: string, done?: HttpResponseCallback<any>)매개 변수
- configurationId
-
string
제거할 구성의 ID
- done
-
HttpResponseCallback<any>
작업이 완료된 경우 호출할 선택적 함수입니다. done 은 Error 개체(null일 수 있음), 응답 본문 및 로깅 또는 디버깅에 유용한 전송별 응답 개체의 세 가지 인수를 사용하여 호출됩니다.
removeDevices(DeviceDescription[], boolean)
function removeDevices(devices: DeviceDescription[], forceRemove: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>매개 변수
- devices
- forceRemove
-
boolean
반환
Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)
디바이스 배열을 업데이트.
function removeDevices(devices: DeviceDescription[], forceRemove: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)매개 변수
- devices
값이 유효한 디바이스 식별자인 deviceId 속성을 포함해야 하는 개체의 배열입니다.
- forceRemove
-
boolean
가 true이면 forceRemove etag에 관계없이 디바이스가 제거됩니다. 그렇지 않으면 etag가 일치해야 합니다.
- done
-
HttpResponseCallback<BulkRegistryOperationResult>
작업이 완료된 경우 호출할 선택적 함수입니다. done 은 Error 개체(null일 수 있음), BulkRegistryOperationResult 및 로깅 또는 디버깅에 유용한 전송별 응답 개체의 세 가지 인수를 사용하여 호출됩니다.
removeModule(Module, TripleValueCallback<any, any>)
레지스트리에서 지정된 모듈 제거
function removeModule(module: Module, done?: TripleValueCallback<any, any>)매개 변수
- module
- Module
- done
-
TripleValueCallback<any, any>
작업이 완료된 경우 호출할 선택적 함수입니다. done 은 Error 개체(null일 수 있음), 응답 본문 및 로깅 또는 디버깅에 유용한 전송별 응답 개체의 세 가지 인수를 사용하여 호출됩니다.
removeModule(string | Module)
function removeModule(moduleOrDeviceId: string | Module): Promise<ResultWithHttpResponse<any>>매개 변수
- moduleOrDeviceId
-
string | Module
반환
Promise<ResultWithHttpResponse<any>>
removeModule(string | Module, string)
function removeModule(moduleOrDeviceId: string | Module, moduleId: string): Promise<ResultWithHttpResponse<any>>매개 변수
- moduleOrDeviceId
-
string | Module
- moduleId
-
string
반환
Promise<ResultWithHttpResponse<any>>
removeModule(string, string, TripleValueCallback<any, any>)
function removeModule(deviceId: string, moduleId: string, done: TripleValueCallback<any, any>)매개 변수
- deviceId
-
string
- moduleId
-
string
- done
-
TripleValueCallback<any, any>
update(DeviceDescription)
function update(deviceInfo: DeviceDescription): Promise<ResultWithHttpResponse<Device>>매개 변수
- deviceInfo
- DeviceDescription
반환
Promise<ResultWithHttpResponse<Device>>
update(DeviceDescription, HttpResponseCallback<Device>)
지정된 디바이스 정보를 사용하여 IoT Hub에서 기존 디바이스 ID를 업데이트.
매개 변수에는 deviceInfo 업다이블할 수 있는 모든 속성이 포함되어야 합니다. 예를 들어 속성을 에서 disabled 로 deviceInfo 업데이트 status 하는 enabled경우 개체에는 statusReason, 인증(및 해당 하위 속성), 기능 및 deviceScope가 디바이스 현재 값으로 설정되거나 해당 속성이 다시 설정됩니다. 업데이트를 수행하기 전에 get api를 먼저 호출하는 것이 좋습니다.
function update(deviceInfo: DeviceDescription, done?: HttpResponseCallback<Device>)매개 변수
- deviceInfo
- DeviceDescription
값이 유효한 디바이스 식별자인 deviceId 속성을 포함해야 하는 개체입니다.
updateConfiguration(Configuration)
function updateConfiguration(configuration: Configuration): Promise<ResultWithHttpResponse<any>>매개 변수
- configuration
- Configuration
반환
Promise<ResultWithHttpResponse<any>>
updateConfiguration(Configuration, boolean)
function updateConfiguration(configuration: Configuration, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>매개 변수
- configuration
- Configuration
- forceUpdate
-
boolean
반환
Promise<ResultWithHttpResponse<any>>
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
function updateConfiguration(configuration: Configuration, forceUpdate: boolean, done: HttpResponseCallback<any>)매개 변수
- configuration
- Configuration
- forceUpdate
-
boolean
- done
-
HttpResponseCallback<any>
updateConfiguration(Configuration, HttpResponseCallback<any>)
IoT Hub에서 구성 업데이트
function updateConfiguration(configuration: Configuration, done?: HttpResponseCallback<any>)매개 변수
- configuration
- Configuration
module:azure-iothub 형식의 개체입니다. 허브에 추가할 구성
- done
-
HttpResponseCallback<any>
작업이 완료된 경우 호출할 선택적 함수입니다. done 은 Error 개체(null일 수 있음), 응답 본문 및 로깅 또는 디버깅에 유용한 전송별 응답 개체의 세 가지 인수를 사용하여 호출됩니다.
updateDevices(DeviceDescription[], boolean)
function updateDevices(devices: DeviceDescription[], forceUpdate: boolean): Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>매개 변수
- devices
- forceUpdate
-
boolean
반환
Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)
디바이스 배열을 업데이트.
매개 변수의 개별 요소에는 devices 업데이트할 수 있는 모든 속성이 포함되어야 합니다. 예를 들어 속성을 에서 로 disabled 업데이트 status 하는 enabled경우 개체에도 statusReason, 인증(및 하위 속성), 기능 및 deviceScope가 디바이스 현재 값으로 설정되거나 해당 속성이 다시 설정됩니다. 업데이트를 수행하기 전에 get api를 먼저 호출하는 것이 좋습니다.
function updateDevices(devices: DeviceDescription[], forceUpdate: boolean, done?: HttpResponseCallback<BulkRegistryOperationResult>)매개 변수
- devices
값이 유효한 디바이스 식별자인 deviceId 속성을 포함해야 하는 개체의 배열입니다.
- forceUpdate
-
boolean
가 true이면 forceUpdate etag에 관계없이 디바이스가 업데이트됩니다. 그렇지 않으면 etag가 일치해야 합니다.
- done
-
HttpResponseCallback<BulkRegistryOperationResult>
작업이 완료된 경우 호출할 선택적 함수입니다. done 는 Error 개체(null일 수 있음), BulkRegistryOperationResult 및 로깅 또는 디버깅에 유용한 전송별 응답 개체의 세 가지 인수를 사용하여 호출됩니다.
updateModule(Module)
function updateModule(module: Module): Promise<ResultWithHttpResponse<any>>매개 변수
- module
- Module
반환
Promise<ResultWithHttpResponse<any>>
updateModule(Module, boolean)
function updateModule(module: Module, forceUpdate: boolean): Promise<ResultWithHttpResponse<any>>매개 변수
- module
- Module
- forceUpdate
-
boolean
반환
Promise<ResultWithHttpResponse<any>>
updateModule(Module, boolean, HttpResponseCallback<any>)
function updateModule(module: Module, forceUpdate: boolean, done: HttpResponseCallback<any>)매개 변수
- module
- Module
- forceUpdate
-
boolean
- done
-
HttpResponseCallback<any>
updateModule(Module, TripleValueCallback<any, any>)
레지스트리에서 지정된 모듈 개체 업데이트
function updateModule(module: Module, done?: TripleValueCallback<any, any>)매개 변수
- module
- Module
업데이트할 모듈 개체입니다.
- done
-
TripleValueCallback<any, any>
작업이 완료된 경우 호출할 선택적 함수입니다. done 는 Error 개체(null일 수 있음), 응답 본문 및 로깅 또는 디버깅에 유용한 전송별 응답 개체의 세 가지 인수를 사용하여 호출됩니다.
updateModuleTwin(string, string, any, string)
function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>매개 변수
- deviceId
-
string
- moduleId
-
string
- patch
-
any
- etag
-
string
반환
Promise<ResultWithHttpResponse<Twin>>
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)
지정된 패치를 사용하여 특정 모듈의 트윈을 업데이트.
function updateModuleTwin(deviceId: string, moduleId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)매개 변수
- deviceId
-
string
디바이스 식별자입니다.
- moduleId
-
string
모듈 식별자
- patch
-
any
모듈 쌍을 패치할 원하는 속성 및 태그입니다.
- etag
-
string
etag를 가져온 이후 모듈 쌍이 업데이트된 경우에도 이 모듈 쌍 또는 '*'에 대한 최신 etag가 강제로 업데이트됩니다.
- done
-
HttpResponseCallback<Twin>
Error 개체 또는 모듈 쌍 인스턴스를 사용하여 호출될 선택적 콜백입니다.
updateTwin(string, any, string)
function updateTwin(deviceId: string, patch: any, etag: string): Promise<ResultWithHttpResponse<Twin>>매개 변수
- deviceId
-
string
- patch
-
any
- etag
-
string
반환
Promise<ResultWithHttpResponse<Twin>>
updateTwin(string, any, string, HttpResponseCallback<Twin>)
지정된 패치를 사용하여 특정 디바이스의 디바이스 쌍을 업데이트.
function updateTwin(deviceId: string, patch: any, etag: string, done?: HttpResponseCallback<Twin>)매개 변수
- deviceId
-
string
디바이스 식별자입니다.
- patch
-
any
디바이스 쌍을 패치할 원하는 속성 및 태그입니다.
- etag
-
string
etag를 가져온 이후 디바이스 쌍이 업데이트된 경우에도 이 디바이스 쌍 또는 '*'에 대한 최신 etag가 강제로 업데이트됩니다.
- done
-
HttpResponseCallback<Twin>
Error 개체 또는 디바이스 쌍 인스턴스를 사용하여 호출될 선택적 콜백입니다.