Registry class

Başvuru

Paket:: azure-iothub

Registry sınıfı, IoT Hub cihaz kimliği hizmetine erişim sağlar. SDK kullanıcıları bu sınıfın örneğini fabrika yöntemlerinden biriyle oluşturmalıdır:ConnectionString 'dan veyaSharedAccessSignature 'dan.

Cihaz kimliği kayıt defteri işlemleri için kullanılan protokol HTTPS'dir.

Yöntemler

addConfiguration(Configuration)
addConfiguration(Configuration, HttpResponseCallback<any>)	IoT hub'ına yapılandırma ekleme.
addDevices(DeviceDescription[])
addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)	Bir cihaz dizisi ekler.
addModule(Module)
addModule(Module, HttpResponseCallback<any>)	Verilen modülü kayıt defterine ekleyin.
applyConfigurationContentOnDevice(string, ConfigurationContent)
applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)	Verilen yapılandırmayı IoT Hub'da bir cihaza uygulama
cancelJob(string)
cancelJob(string, Callback<JobStatus>)	Toplu içeri/dışarı aktarma işini iptal etme.
create(DeviceDescription)
create(DeviceDescription, HttpResponseCallback<Device>)	IoT hub'ına yeni bir cihaz kimliği oluşturur.
createQuery(string, number)	Cihazlar veya işler hakkında bilgi bulmak için IoT Hub örneğinde çalıştırılabilir bir sorgu oluşturur.
delete(string)
delete(string, HttpResponseCallback<any>)	IoT hub'ından mevcut cihaz kimliğini kaldırır.
exportDevicesToBlob(string, boolean)
exportDevicesToBlob(string, boolean, Callback<JobStatus>)	Cihazları toplu bir işteki bir bloba aktarın.
exportDevicesToBlobByIdentity(string, boolean)
exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)	Yapılandırılmış bir kimlik kullanarak cihazları toplu iş içindeki bir bloba aktarın.
exportDevicesToBlobByIdentity(string, boolean, string)
exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)
fromConnectionString(string)	Verilen bağlantı dizesinden bir Kayıt Defteri nesnesi oluşturur.
fromSharedAccessSignature(string)	Verilen paylaşılan erişim imzasından bir Kayıt Defteri nesnesi oluşturur.
fromTokenCredential(string, TokenCredential)	Verilen Azure TokenCredential öğesinden bir Kayıt Defteri nesnesi oluşturur.
get(string)
get(string, HttpResponseCallback<Device>)	IoT hub'ına var olan bir cihaz kimliği hakkında bilgi istemektedir.
getConfiguration(string)
getConfiguration(string, HttpResponseCallback<Configuration>)	IoT Hub'dan tek bir yapılandırma alma
getConfigurations()
getConfigurations(HttpResponseCallback<Configuration[]>)	IoT Hub'da tüm yapılandırmaları alma
getJob(string)
getJob(string, Callback<JobStatus>)	Toplu içeri/dışarı aktarma işinin durumunu alın.
getModule(string, string)
getModule(string, string, HttpResponseCallback<Module>)	IoT Hub'da bir cihazdan tek bir modül alma
getModulesOnDevice(string)
getModulesOnDevice(string, HttpResponseCallback<Module[]>)	IoT Hub cihazındaki tüm modüllerin listesini alma
getModuleTwin(string, string)
getModuleTwin(string, string, HttpResponseCallback<Twin>)	Belirtilen modül tanımlayıcısıyla modülün Modül İkizi'ni alır.
getRegistryStatistics()
getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)	Cihaz kimliği kayıt defterindeki cihazlarla ilgili istatistikleri alır.
getTwin(string)
getTwin(string, HttpResponseCallback<Twin>)	Belirtilen cihaz tanımlayıcısıyla cihazın Cihaz İkizi'ni alır.
importDevicesFromBlob(string, string)
importDevicesFromBlob(string, string, Callback<JobStatus>)	Toplu işteki bir blobdan cihazları içeri aktarır.
importDevicesFromBlobByIdentity(string, string)
importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)	Yapılandırılmış bir kimlik kullanarak toplu işteki bir blobdan cihazları içeri aktarır.
importDevicesFromBlobByIdentity(string, string, string)
importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)
list()
list(HttpResponseCallback<Device[]>)	IoT hub'ına ilk 1000 cihaz kimliği hakkında bilgi istemektedir.
listJobs()
listJobs(HttpResponseCallback<any>)	Son içeri/dışarı aktarma işlerini (varsa etkin olan dahil) listeleyin.
removeConfiguration(string)
removeConfiguration(string, HttpResponseCallback<any>)	IoT Hub'dan verilen kimlikle yapılandırmayı kaldırma
removeDevices(DeviceDescription[], boolean)
removeDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Bir cihaz dizisini güncelleştirir.
removeModule(Module, TripleValueCallback<any, any>)	Verilen modülü kayıt defterinden kaldırma
removeModule(string \| Module)
removeModule(string \| Module, string)
removeModule(string, string, TripleValueCallback<any, any>)
update(DeviceDescription)
update(DeviceDescription, HttpResponseCallback<Device>)	IoT hub'ı üzerindeki mevcut cihaz kimliğini verilen cihaz bilgileriyle güncelleştirir. `deviceInfo` parametresi güncelleştirilebilir tüm özellikleri içermelidir. Örneğin, `status` özelliğini `disabled`'den `enabled`'e güncelleştiriyorsanız, `deviceInfo` nesnesinin de durumReason, kimlik doğrulaması (ve alt özellikleri), özellikleri ve deviceScope'un cihazların geçerli değerlerine ayarlanmış olması gerekir veya bu özellikler sıfırlanır. Güncelleştirme yapmadan önce get API'sinin çağrılmış olması önerilir.
updateConfiguration(Configuration)
updateConfiguration(Configuration, boolean)
updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)
updateConfiguration(Configuration, HttpResponseCallback<any>)	IoT hub'ında yapılandırmayı güncelleştirme
updateDevices(DeviceDescription[], boolean)
updateDevices(DeviceDescription[], boolean, HttpResponseCallback<BulkRegistryOperationResult>)	Bir cihaz dizisini güncelleştirir. `devices` parametresinin tek tek öğeleri güncelleştirilebilir tüm özellikleri içermelidir. Örneğin, `status` özelliğini `disabled`'den `enabled`'e güncelleştiriyorsanız, nesnenin de statusReason, kimlik doğrulaması (ve alt özellikleri), özellikleri ve deviceScope'un cihazların geçerli değerlerine ayarlanmış olması gerekir veya bu özellikler sıfırlanır. Güncelleştirme yapmadan önce get API'sinin çağrılmış olması önerilir.
updateModule(Module)
updateModule(Module, boolean)
updateModule(Module, boolean, HttpResponseCallback<any>)
updateModule(Module, TripleValueCallback<any, any>)	Kayıt defterinde verilen modül nesnesini güncelleştirme
updateModuleTwin(string, string, any, string)
updateModuleTwin(string, string, any, string, HttpResponseCallback<Twin>)	Belirli bir modülün ikizini verilen yamayla güncelleştirir.
updateTwin(string, any, string)
updateTwin(string, any, string, HttpResponseCallback<Twin>)	Belirli bir cihazın Cihaz İkizi'ni verilen yamayla güncelleştirir.

Yöntem Ayrıntıları

addConfiguration(Configuration)

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

Parametreler

configuration: Configuration

Döndürülenler

Promise<ResultWithHttpResponse<any>>

addConfiguration(Configuration, HttpResponseCallback<any>)

IoT hub'ına yapılandırma ekleme.

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

Parametreler

configuration: Configuration

module:azure-iothub türünde bir nesne. Hub'a eklenecek yapılandırma

done: HttpResponseCallback<any>

İşlem tamamlandığında çağrılacak isteğe bağlı işlev. done üç bağımsız değişkenle çağrılır: Hata nesnesi (null olabilir), yanıtın gövdesi ve günlüğe kaydetme veya hata ayıklama için yararlı aktarıma özgü yanıt nesnesi.

addDevices(DeviceDescription[])

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

Parametreler

devices: DeviceDescription[]

Döndürülenler

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Bir cihaz dizisi ekler.

function addDevices(devices: DeviceDescription[], done?: HttpResponseCallback<BulkRegistryOperationResult>)

Parametreler

devices: DeviceDescription[]

Değeri geçerli bir cihaz tanımlayıcısı olan bir deviceId özelliği içermesi gereken bir nesne dizisi.

done: HttpResponseCallback<BulkRegistryOperationResult>

İşlem tamamlandığında çağrılacak isteğe bağlı işlev. done üç bağımsız değişkenle çağrılır: Error nesnesi (null olabilir), BulkRegistryOperationResult ve günlüğe kaydetme veya hata ayıklama için kullanışlı aktarıma özgü yanıt nesnesi.

addModule(Module)

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

Parametreler

module: Module

Döndürülenler

Promise<ResultWithHttpResponse<any>>

addModule(Module, HttpResponseCallback<any>)

Verilen modülü kayıt defterine ekleyin.

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

Parametreler

module: Module

Kayıt defterine eklenecek modül nesnesi.

done: HttpResponseCallback<any>

applyConfigurationContentOnDevice(string, ConfigurationContent)

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

Parametreler

deviceId: string

content: ConfigurationContent

Döndürülenler

Promise<ResultWithHttpResponse<any>>

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Verilen yapılandırmayı IoT Hub'da bir cihaza uygulama

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

Parametreler

deviceId: string

Yapılandırmanın uygulanacağı cihazın kimliği

content: ConfigurationContent

Uygulanacak Yapılandırma

done: HttpResponseCallback<any>

cancelJob(string)

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

Parametreler

jobId: string

Döndürülenler

Promise<JobStatus>

cancelJob(string, Callback<JobStatus>)

Toplu içeri/dışarı aktarma işini iptal etme.

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

Parametreler

jobId: string

Kullanıcının durum bilgilerini almak istediği işin tanımlayıcısı.

done: Callback<JobStatus>

İki bağımsız değişkenle çağrılan isteğe bağlı işlev: bir hata oluştuysa hata nesnesi, (aksi takdirde null) ve tanımlayıcısı bağımsız değişken olarak geçirilen işin (iptal edildi) durumu.

create(DeviceDescription)

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

Parametreler

deviceInfo: DeviceDescription

Döndürülenler

Promise<ResultWithHttpResponse<Device>>

create(DeviceDescription, HttpResponseCallback<Device>)

IoT hub'ına yeni bir cihaz kimliği oluşturur.

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

Parametreler

deviceInfo: DeviceDescription

Nesnenin geçerli bir cihaz tanımlayıcısı olan bir deviceId özelliği içermesi gerekir.

done: HttpResponseCallback<Device>

İşlem tamamlandığında çağrılacak isteğe bağlı işlev. done üç bağımsız değişkenle çağrılır: Hata nesnesi (null olabilir), oluşturulan cihaz kimliğini temsil eden Cihaz nesnesi ve günlüğe kaydetme veya hata ayıklama için yararlı olan aktarıma özgü yanıt nesnesi.

createQuery(string, number)

Cihazlar veya işler hakkında bilgi bulmak için IoT Hub örneğinde çalıştırılabilir bir sorgu oluşturur.

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

Parametreler

sqlQuery: string

SQL dizesi olarak yazılan sorgu.

pageSize: number

Sayfa başına istenen sonuç sayısı (isteğe bağlı. varsayılan: 1000, maksimum: 10000).

Döndürülenler

Query

delete(string)

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

Parametreler

deviceId: string

Döndürülenler

Promise<ResultWithHttpResponse<any>>

delete(string, HttpResponseCallback<any>)

IoT hub'ından mevcut cihaz kimliğini kaldırır.

function delete(deviceId: string, done?: HttpResponseCallback<any>)

Parametreler

deviceId: string

Mevcut bir cihaz kimliğinin tanımlayıcısı.

done: HttpResponseCallback<any>

İşlem tamamlandığında çağrılacak isteğe bağlı işlev. done üç bağımsız değişkenle çağrılır: Hata nesnesi (null olabilir), her zaman null bağımsız değişken (diğer yöntemlerle tutarlılık için) ve günlüğe kaydetme veya hata ayıklama için yararlı olan aktarıma özgü yanıt nesnesi.

exportDevicesToBlob(string, boolean)

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

Parametreler

outputBlobContainerUri: string

excludeKeys: boolean

Döndürülenler

Promise<JobStatus>

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Cihazları toplu bir işteki bir bloba aktarın.

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

Parametreler

outputBlobContainerUri: string

Cihaz listesini içeren 'devices.txt' adlı bir blobun oluşturulacağı kapsayıcının URI'si.

excludeKeys: boolean

Güvenlik anahtarlarının dışarı aktarılan verilerden dışlanıp dışlanmayacağını gösteren Boole değeri.

done: Callback<JobStatus>

İş oluşturulduğunda çağırılacak isteğe bağlı işlev, iki bağımsız değişkenle: bir hata oluştuğunda hata nesnesi, (aksi takdirde null) ve cihazların dışarı aktarma işleminin ilerleme durumunu izlemek için kullanılabilecek iş durumu.

exportDevicesToBlobByIdentity(string, boolean)

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

Parametreler

outputBlobContainerUri: string

excludeKeys: boolean

Döndürülenler

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Yapılandırılmış bir kimlik kullanarak cihazları toplu iş içindeki bir bloba aktarın.

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

Parametreler

outputBlobContainerUri: string

Cihaz listesini içeren 'devices.txt' adlı bir blobun oluşturulacağı kapsayıcının URI'si.

excludeKeys: boolean

Güvenlik anahtarlarının dışarı aktarılan verilerden dışlanıp dışlanmayacağını gösteren Boole değeri.

done: Callback<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, string)

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

Parametreler

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

Döndürülenler

Promise<JobStatus>

exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)

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

Parametreler

outputBlobContainerUri: string

excludeKeys: boolean

userAssignedIdentity: string

done: Callback<JobStatus>

fromConnectionString(string)

Verilen bağlantı dizesinden bir Kayıt Defteri nesnesi oluşturur.

static function fromConnectionString(value: string): Registry

Parametreler

value: string

Uygun (okuma ve/veya yazma) Kayıt Defteri izinlerini kapsülleyen bir bağlantı dizesi.

Döndürülenler

Registry

fromSharedAccessSignature(string)

Verilen paylaşılan erişim imzasından bir Kayıt Defteri nesnesi oluşturur.

static function fromSharedAccessSignature(value: string): Registry

Parametreler

value: string

Uygun (okuma ve/veya yazma) Kayıt Defteri izinlerini kapsülleyen paylaşılan erişim imzası.

Döndürülenler

Registry

fromTokenCredential(string, TokenCredential)

Verilen Azure TokenCredential öğesinden bir Kayıt Defteri nesnesi oluşturur.

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

Parametreler

hostName: string

Azure hizmetinin ana bilgisayar adı.

tokenCredential: TokenCredential

Azure hizmetiyle kimlik doğrulaması yapmak için kullanılan Azure TokenCredential

Döndürülenler

Registry

get(string)

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

Parametreler

deviceId: string

Döndürülenler

Promise<ResultWithHttpResponse<Device>>

get(string, HttpResponseCallback<Device>)

IoT hub'ına var olan bir cihaz kimliği hakkında bilgi istemektedir.

function get(deviceId: string, done?: HttpResponseCallback<Device>)

Parametreler

deviceId: string

Mevcut bir cihaz kimliğinin tanımlayıcısı.

done: HttpResponseCallback<Device>

getConfiguration(string)

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

Parametreler

configurationId: string

Döndürülenler

Promise<ResultWithHttpResponse<Configuration>>

getConfiguration(string, HttpResponseCallback<Configuration>)

IoT Hub'dan tek bir yapılandırma alma

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

Parametreler

configurationId: string

Almak istediğiniz yapılandırmanın kimliği

done: HttpResponseCallback<Configuration>

Bir Error nesnesi veya bir modülle çağrılacak isteğe bağlı geri çağırma:azure-iothub. Yapılandırma ayrıntılarını içeren yapılandırma nesnesi.

getConfigurations()

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

Döndürülenler

Promise<ResultWithHttpResponse<Configuration[]>>

getConfigurations(HttpResponseCallback<Configuration[]>)

IoT Hub'da tüm yapılandırmaları alma

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

Parametreler

done: HttpResponseCallback<Configuration[]>

Bir Error nesnesi veya bir module:azure-iothub dizisi ile çağrılan isteğe bağlı geri çağırma. Tüm yapılandırmalar için yapılandırma nesneleri.

getJob(string)

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

Parametreler

jobId: string

Döndürülenler

Promise<JobStatus>

getJob(string, Callback<JobStatus>)

Toplu içeri/dışarı aktarma işinin durumunu alın.

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

Parametreler

jobId: string

Kullanıcının durum bilgilerini almak istediği işin tanımlayıcısı.

done: Callback<JobStatus>

İki bağımsız değişkenle çağrılan isteğe bağlı işlev: bir hata oluştuysa hata nesnesi, (aksi takdirde null) ve tanımlayıcısı bağımsız değişken olarak geçirilen işin durumu.

getModule(string, string)

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

Parametreler

deviceId: string

moduleId: string

Döndürülenler

Promise<ResultWithHttpResponse<Module>>

getModule(string, string, HttpResponseCallback<Module>)

IoT Hub'da bir cihazdan tek bir modül alma

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

Parametreler

deviceId: string

Modülün sahibi olan cihaz kimliği.

moduleId: string

Alınacak modül kimliği

done: HttpResponseCallback<Module>

Bir Error nesnesi veya modülüyle çağrılacak isteğe bağlı geri çağırma:azure-iothub. İstenen modül için modül nesnesi

getModulesOnDevice(string)

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

Parametreler

deviceId: string

Döndürülenler

Promise<ResultWithHttpResponse<Module[]>>

getModulesOnDevice(string, HttpResponseCallback<Module[]>)

IoT Hub cihazındaki tüm modüllerin listesini alma

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

Parametreler

deviceId: string

Modülleri aldığımız cihazın kimliği

done: HttpResponseCallback<Module[]>

Bir Error nesnesi veya bir module:azure-iothub dizisi ile çağrılan isteğe bağlı geri çağırma. Tüm modüller için modül nesneleri.

getModuleTwin(string, string)

function getModuleTwin(deviceId: string, moduleId: string): Promise<ResultWithHttpResponse<Twin>>

Parametreler

deviceId: string

moduleId: string

Döndürülenler

Promise<ResultWithHttpResponse<Twin>>

getModuleTwin(string, string, HttpResponseCallback<Twin>)

Belirtilen modül tanımlayıcısıyla modülün Modül İkizi'ni alır.

function getModuleTwin(deviceId: string, moduleId: string, done?: HttpResponseCallback<Twin>)

Parametreler

deviceId: string

Cihaz tanımlayıcısı.

moduleId: string

Modül tanımlayıcısı.

done: HttpResponseCallback<Twin>

Bir Error nesnesiyle veya modül ikizi örneğiyle çağrılacak isteğe bağlı geri çağırma.

getRegistryStatistics()

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

Döndürülenler

Promise<ResultWithHttpResponse<RegistryStatistics>>

getRegistryStatistics(HttpResponseCallback<RegistryStatistics>)

Cihaz kimliği kayıt defterindeki cihazlarla ilgili istatistikleri alır.

function getRegistryStatistics(done?: HttpResponseCallback<RegistryStatistics>)

Parametreler

done: HttpResponseCallback<RegistryStatistics>

Bir Error nesnesi veya cihaz kayıt defteri istatistikleriyle çağrılacak isteğe bağlı geri arama.

getTwin(string)

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

Parametreler

deviceId: string

Döndürülenler

Promise<ResultWithHttpResponse<Twin>>

getTwin(string, HttpResponseCallback<Twin>)

Belirtilen cihaz tanımlayıcısıyla cihazın Cihaz İkizi'ni alır.

function getTwin(deviceId: string, done?: HttpResponseCallback<Twin>)

Parametreler

deviceId: string

Cihaz tanımlayıcısı.

done: HttpResponseCallback<Twin>

Bir Error nesnesi veya cihaz ikizi örneğiyle çağrılacak isteğe bağlı geri çağırma.

importDevicesFromBlob(string, string)

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

Parametreler

inputBlobContainerUri: string

outputBlobContainerUri: string

Döndürülenler

Promise<JobStatus>

importDevicesFromBlob(string, string, Callback<JobStatus>)

Toplu işteki bir blobdan cihazları içeri aktarır.

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

Parametreler

inputBlobContainerUri: string

İçeri aktaracak cihazların listesini içeren 'devices.txt' adlı bloba sahip bir kapsayıcının URI'sini.

outputBlobContainerUri: string

İçeri aktarma işleminin günlükleriyle blobun oluşturulacağı kapsayıcının URI'si.

done: Callback<JobStatus>

İş oluşturulduğunda çağrı yapmak için isteğe bağlı işlev, iki bağımsız değişkenle: bir hata oluştuysa hata nesnesi( aksi takdirde null) ve cihazların içeri aktarma işleminin ilerleme durumunu izlemek için kullanılabilecek iş durumu.

importDevicesFromBlobByIdentity(string, string)

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

Parametreler

inputBlobContainerUri: string

outputBlobContainerUri: string

Döndürülenler

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, Callback<JobStatus>)

Yapılandırılmış bir kimlik kullanarak toplu işteki bir blobdan cihazları içeri aktarır.

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

Parametreler

inputBlobContainerUri: string

İçeri aktaracak cihazların listesini içeren 'devices.txt' adlı bloba sahip bir kapsayıcının URI'sini.

outputBlobContainerUri: string

İçeri aktarma işleminin günlükleriyle blobun oluşturulacağı kapsayıcının URI'si.

done: Callback<JobStatus>

importDevicesFromBlobByIdentity(string, string, string)

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

Parametreler

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

Döndürülenler

Promise<JobStatus>

importDevicesFromBlobByIdentity(string, string, string, Callback<JobStatus>)

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

Parametreler

inputBlobContainerUri: string

outputBlobContainerUri: string

userAssignedIdentity: string

done: Callback<JobStatus>

list()

function list(): Promise<ResultWithHttpResponse<Device[]>>

Döndürülenler

Promise<ResultWithHttpResponse<Device[]>>

list(HttpResponseCallback<Device[]>)

IoT hub'ına ilk 1000 cihaz kimliği hakkında bilgi istemektedir.

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

Parametreler

done: HttpResponseCallback<Device[]>

İşlem tamamlandığında çağrılacak isteğe bağlı işlev. done üç bağımsız değişkenle çağrılır: Hata nesnesi (null olabilir), listelenen cihaz kimliklerini temsil eden Cihaz nesneleri dizisi ve günlüğe kaydetme veya hata ayıklama için yararlı olan aktarıma özgü yanıt nesnesi.

listJobs()

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

Döndürülenler

Promise<ResultWithHttpResponse<any>>

listJobs(HttpResponseCallback<any>)

Son içeri/dışarı aktarma işlerini (varsa etkin olan dahil) listeleyin.

function listJobs(done?: HttpResponseCallback<any>)

Parametreler

done: HttpResponseCallback<any>

İki bağımsız değişkenle çağrılacak isteğe bağlı işlev: bir hata oluştuysa hata nesnesi ( aksi takdirde null) ve bağımsız değişken olarak geçmiş işlerin listesi.

removeConfiguration(string)

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

Parametreler

configurationId: string

Döndürülenler

Promise<ResultWithHttpResponse<any>>

removeConfiguration(string, HttpResponseCallback<any>)

IoT Hub'dan verilen kimlikle yapılandırmayı kaldırma

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

Parametreler

configurationId: string

Kaldırılacak yapılandırmanın kimliği

done: HttpResponseCallback<any>

removeDevices(DeviceDescription[], boolean)

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

Parametreler

devices: DeviceDescription[]

forceRemove: boolean

Döndürülenler

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Bir cihaz dizisini güncelleştirir.

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

Parametreler

devices: DeviceDescription[]

Değeri geçerli bir cihaz tanımlayıcısı olan bir deviceId özelliği içermesi gereken bir nesne dizisi.

forceRemove: boolean

forceRemove doğruysa, cihaz etag'dan bağımsız olarak kaldırılır. Aksi takdirde etag'ler eşleşmelidir.

done: HttpResponseCallback<BulkRegistryOperationResult>

removeModule(Module, TripleValueCallback<any, any>)

Verilen modülü kayıt defterinden kaldırma

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

Parametreler

module: Module

done: TripleValueCallback<any, any>

removeModule(string | Module)

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

Parametreler

moduleOrDeviceId: string | Module

Döndürülenler

Promise<ResultWithHttpResponse<any>>

removeModule(string | Module, string)

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

Parametreler

moduleOrDeviceId: string | Module

moduleId: string

Döndürülenler

Promise<ResultWithHttpResponse<any>>

removeModule(string, string, TripleValueCallback<any, any>)

function removeModule(deviceId: string, moduleId: string, done: TripleValueCallback<any, any>)

Parametreler

deviceId: string

moduleId: string

done: TripleValueCallback<any, any>

update(DeviceDescription)

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

Parametreler

deviceInfo: DeviceDescription

Döndürülenler

Promise<ResultWithHttpResponse<Device>>

update(DeviceDescription, HttpResponseCallback<Device>)

IoT hub'ı üzerindeki mevcut cihaz kimliğini verilen cihaz bilgileriyle güncelleştirir. deviceInfo parametresi güncelleştirilebilir tüm özellikleri içermelidir. Örneğin, status özelliğini disabled'den enabled'e güncelleştiriyorsanız, deviceInfo nesnesinin de durumReason, kimlik doğrulaması (ve alt özellikleri), özellikleri ve deviceScope'un cihazların geçerli değerlerine ayarlanmış olması gerekir veya bu özellikler sıfırlanır. Güncelleştirme yapmadan önce get API'sinin çağrılmış olması önerilir.

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

Parametreler

deviceInfo: DeviceDescription

Değeri geçerli bir cihaz tanımlayıcısı olan bir deviceId özelliği içermesi gereken nesne.

done: HttpResponseCallback<Device>

İşlem tamamlandığında çağrılacak isteğe bağlı işlev. done üç bağımsız değişkenle çağrılır: Bir Hata nesnesi (null olabilir), güncelleştirilmiş cihaz kimliğini temsil eden Cihaz nesnesi ve günlüğe kaydetme veya hata ayıklama için yararlı olan aktarıma özgü yanıt nesnesi.

updateConfiguration(Configuration)

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

Parametreler

configuration: Configuration

Döndürülenler

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean)

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

Parametreler

configuration: Configuration

forceUpdate: boolean

Döndürülenler

Promise<ResultWithHttpResponse<any>>

updateConfiguration(Configuration, boolean, HttpResponseCallback<any>)

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

Parametreler

configuration: Configuration

forceUpdate: boolean

done: HttpResponseCallback<any>

updateConfiguration(Configuration, HttpResponseCallback<any>)

IoT hub'ında yapılandırmayı güncelleştirme

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

Parametreler

configuration: Configuration

module:azure-iothub türünde bir nesne. Hub'a eklenecek yapılandırma

done: HttpResponseCallback<any>

updateDevices(DeviceDescription[], boolean)

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

Parametreler

devices: DeviceDescription[]

forceUpdate: boolean

Döndürülenler

Promise<ResultWithHttpResponse<BulkRegistryOperationResult>>

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

Bir cihaz dizisini güncelleştirir. devices parametresinin tek tek öğeleri güncelleştirilebilir tüm özellikleri içermelidir. Örneğin, status özelliğini disabled'den enabled'e güncelleştiriyorsanız, nesnenin de statusReason, kimlik doğrulaması (ve alt özellikleri), özellikleri ve deviceScope'un cihazların geçerli değerlerine ayarlanmış olması gerekir veya bu özellikler sıfırlanır. Güncelleştirme yapmadan önce get API'sinin çağrılmış olması önerilir.

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

Parametreler

devices: DeviceDescription[]

Değeri geçerli bir cihaz tanımlayıcısı olan bir deviceId özelliği içermesi gereken bir nesne dizisi.

forceUpdate: boolean

forceUpdate doğruysa cihaz bir etag'e bakılmaksızın güncelleştirilir. Aksi takdirde etag'ler eşleşmelidir.

done: HttpResponseCallback<BulkRegistryOperationResult>

updateModule(Module)

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

Parametreler

module: Module

Döndürülenler

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean)

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

Parametreler

module: Module

forceUpdate: boolean

Döndürülenler

Promise<ResultWithHttpResponse<any>>

updateModule(Module, boolean, HttpResponseCallback<any>)

function updateModule(module: Module, forceUpdate: boolean, done: HttpResponseCallback<any>)

Parametreler

module: Module

forceUpdate: boolean

done: HttpResponseCallback<any>

updateModule(Module, TripleValueCallback<any, any>)

Kayıt defterinde verilen modül nesnesini güncelleştirme

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

Parametreler

module: Module

Güncelleştirilecek modül nesnesi.

done: TripleValueCallback<any, any>

updateModuleTwin(string, string, any, string)

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

Parametreler

deviceId: string

moduleId: string

patch: any

etag: string

Döndürülenler

Promise<ResultWithHttpResponse<Twin>>

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

Belirli bir modülün ikizini verilen yamayla güncelleştirir.

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

Parametreler

deviceId: string

Cihaz tanımlayıcısı.

moduleId: string

Modül tanımlayıcısı

patch: any

Modül ikizine yama uygulamak için istenen özellikler ve etiketler.

etag: string

Bu modül ikizi veya '*' için en son etag, etag elde edildikten sonra modül ikizi güncelleştirilmiş olsa bile bir güncelleştirmeyi zorlamak için kullanılır.

done: HttpResponseCallback<Twin>

Bir Error nesnesiyle veya modül ikizi örneğiyle çağrılacak isteğe bağlı geri çağırma.

updateTwin(string, any, string)

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

Parametreler

deviceId: string

patch: any

etag: string

Döndürülenler

Promise<ResultWithHttpResponse<Twin>>

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

Belirli bir cihazın Cihaz İkizi'ni verilen yamayla güncelleştirir.

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

Parametreler

deviceId: string

Cihaz tanımlayıcısı.

patch: any

Cihaz ikizine yama uygulamak için istenen özellikler ve etiketler.

etag: string

Etag elde edildikten sonra cihaz ikizi güncelleştirilmiş olsa bile bir güncelleştirmeyi zorlamak için bu cihaz ikizi veya '*' için en son etag.

done: HttpResponseCallback<Twin>

Bir Error nesnesi veya cihaz ikizi örneğiyle çağrılacak isteğe bağlı geri çağırma.

Aracılığıyla paylaş

Registry class

Yöntemler

Yöntem Ayrıntıları

addConfiguration(Configuration)

Parametreler

Döndürülenler

addConfiguration(Configuration, HttpResponseCallback<any>)

Parametreler

addDevices(DeviceDescription[])

Parametreler

Döndürülenler

addDevices(DeviceDescription[], HttpResponseCallback<BulkRegistryOperationResult>)

Parametreler

addModule(Module)

Parametreler

Döndürülenler

addModule(Module, HttpResponseCallback<any>)

Parametreler

applyConfigurationContentOnDevice(string, ConfigurationContent)

Parametreler

Döndürülenler

applyConfigurationContentOnDevice(string, ConfigurationContent, HttpResponseCallback<any>)

Parametreler

cancelJob(string)

Parametreler

Döndürülenler

cancelJob(string, Callback<JobStatus>)

Parametreler

create(DeviceDescription)

Parametreler

Döndürülenler

create(DeviceDescription, HttpResponseCallback<Device>)

Parametreler

createQuery(string, number)

Parametreler

Döndürülenler

delete(string)

Parametreler

Döndürülenler

delete(string, HttpResponseCallback<any>)

Parametreler

exportDevicesToBlob(string, boolean)

Parametreler

Döndürülenler

exportDevicesToBlob(string, boolean, Callback<JobStatus>)

Parametreler

exportDevicesToBlobByIdentity(string, boolean)

Parametreler

Döndürülenler

exportDevicesToBlobByIdentity(string, boolean, Callback<JobStatus>)

Parametreler

exportDevicesToBlobByIdentity(string, boolean, string)

Parametreler

Döndürülenler

exportDevicesToBlobByIdentity(string, boolean, string, Callback<JobStatus>)

Parametreler

fromConnectionString(string)

Parametreler

Döndürülenler

fromSharedAccessSignature(string)

Parametreler

Döndürülenler

fromTokenCredential(string, TokenCredential)

Parametreler

Döndürülenler

get(string)

Parametreler

Döndürülenler

get(string, HttpResponseCallback<Device>)

Parametreler

getConfiguration(string)

Parametreler

Döndürülenler

getConfiguration(string, HttpResponseCallback<Configuration>)

Parametreler

getConfigurations()

Döndürülenler

getConfigurations(HttpResponseCallback<Configuration[]>)

Parametreler