IotHubResource interface

Antarmuka yang mewakili IotHubResource.

Metode

beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)

Membuat atau memperbarui metadata hub Iot. Pola yang biasa untuk memodifikasi properti adalah mengambil metadata hub IoT dan metadata keamanan, lalu menggabungkannya dengan nilai yang dimodifikasi dalam isi baru untuk memperbarui hub IoT. Jika properti tertentu hilang di JSON, memperbarui IoT Hub dapat menyebabkan nilai-nilai ini mundur ke default, yang dapat menyebabkan perilaku yang tidak terduga.

beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)

Membuat atau memperbarui metadata hub Iot. Pola yang biasa untuk memodifikasi properti adalah mengambil metadata hub IoT dan metadata keamanan, lalu menggabungkannya dengan nilai yang dimodifikasi dalam isi baru untuk memperbarui hub IoT. Jika properti tertentu hilang di JSON, memperbarui IoT Hub dapat menyebabkan nilai-nilai ini mundur ke default, yang dapat menyebabkan perilaku yang tidak terduga.

beginDelete(string, string, IotHubResourceDeleteOptionalParams)

Menghapus hub IoT.

beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)

Menghapus hub IoT.

beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)

Perbarui tag IoT Hub yang ada. untuk memperbarui bidang lain menggunakan metode CreateOrUpdate

beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)

Perbarui tag IoT Hub yang ada. untuk memperbarui bidang lain menggunakan metode CreateOrUpdate

checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)

Periksa apakah nama hub IoT tersedia.

createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)

Tambahkan grup konsumen ke titik akhir yang kompatibel dengan Event Hub di hub IoT.

deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)

Menghapus grup konsumen dari titik akhir yang kompatibel dengan Event Hub di hub IoT.

exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)

Mengekspor semua identitas perangkat di registri identitas hub IoT ke kontainer blob Azure Storage. Untuk informasi selengkapnya, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

get(string, string, IotHubResourceGetOptionalParams)

Dapatkan metadata terkait non-keamanan dari hub IoT.

getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)

Dapatkan grup konsumen dari titik akhir perangkat-ke-cloud yang kompatibel dengan Event Hub untuk hub IoT.

getJob(string, string, string, IotHubResourceGetJobOptionalParams)

Dapatkan detail pekerjaan dari hub IoT. Untuk informasi selengkapnya, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)

Dapatkan kebijakan akses bersama berdasarkan nama dari hub IoT. Untuk informasi selengkapnya, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

getStats(string, string, IotHubResourceGetStatsOptionalParams)

Dapatkan statistik dari hub IoT.

importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)

Mengimpor, memperbarui, atau menghapus identitas perangkat di registri identitas hub IoT dari blob. Untuk informasi selengkapnya, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)

Dapatkan semua hub IoT dalam grup sumber daya.

listBySubscription(IotHubResourceListBySubscriptionOptionalParams)

Dapatkan semua hub IoT dalam langganan.

listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)

Dapatkan kesehatan untuk titik akhir perutean.

listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)

Dapatkan daftar grup konsumen di titik akhir perangkat-ke-cloud yang kompatibel dengan Event Hub di hub IoT.

listJobs(string, string, IotHubResourceListJobsOptionalParams)

Dapatkan daftar semua pekerjaan di hub IoT. Untuk informasi selengkapnya, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

listKeys(string, string, IotHubResourceListKeysOptionalParams)

Dapatkan metadata keamanan untuk hub IoT. Untuk informasi selengkapnya, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)

Dapatkan metrik kuota untuk hub IoT.

listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)

Dapatkan daftar SKU yang valid untuk hub IoT.

testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)

Uji semua rute yang dikonfigurasi di Iot Hub ini

testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)

Uji rute baru untuk Iot Hub ini

Detail Metode

beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)

Membuat atau memperbarui metadata hub Iot. Pola yang biasa untuk memodifikasi properti adalah mengambil metadata hub IoT dan metadata keamanan, lalu menggabungkannya dengan nilai yang dimodifikasi dalam isi baru untuk memperbarui hub IoT. Jika properti tertentu hilang di JSON, memperbarui IoT Hub dapat menyebabkan nilai-nilai ini mundur ke default, yang dapat menyebabkan perilaku yang tidak terduga.

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

iotHubDescription
IotHubDescription

Metadata hub IoT dan metadata keamanan.

Mengembalikan

Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>

beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)

Membuat atau memperbarui metadata hub Iot. Pola yang biasa untuk memodifikasi properti adalah mengambil metadata hub IoT dan metadata keamanan, lalu menggabungkannya dengan nilai yang dimodifikasi dalam isi baru untuk memperbarui hub IoT. Jika properti tertentu hilang di JSON, memperbarui IoT Hub dapat menyebabkan nilai-nilai ini mundur ke default, yang dapat menyebabkan perilaku yang tidak terduga.

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

iotHubDescription
IotHubDescription

Metadata hub IoT dan metadata keamanan.

Mengembalikan

beginDelete(string, string, IotHubResourceDeleteOptionalParams)

Menghapus hub IoT.

function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

options
IotHubResourceDeleteOptionalParams

Parameter opsi.

Mengembalikan

Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>

beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)

Menghapus hub IoT.

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

options
IotHubResourceDeleteOptionalParams

Parameter opsi.

Mengembalikan

beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)

Perbarui tag IoT Hub yang ada. untuk memperbarui bidang lain menggunakan metode CreateOrUpdate

function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>

Parameter

resourceGroupName

string

Pengidentifikasi grup sumber daya.

resourceName

string

Nama iot hub untuk diperbarui.

iotHubTags
TagsResource

Informasi tag yang diperbarui untuk diatur ke dalam instans hub iot.

options
IotHubResourceUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>

beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)

Perbarui tag IoT Hub yang ada. untuk memperbarui bidang lain menggunakan metode CreateOrUpdate

function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>

Parameter

resourceGroupName

string

Pengidentifikasi grup sumber daya.

resourceName

string

Nama iot hub untuk diperbarui.

iotHubTags
TagsResource

Informasi tag yang diperbarui untuk diatur ke dalam instans hub iot.

options
IotHubResourceUpdateOptionalParams

Parameter opsi.

Mengembalikan

checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)

Periksa apakah nama hub IoT tersedia.

function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>

Parameter

operationInputs
OperationInputs

Atur parameter nama dalam struktur OperationInputs ke nama hub IoT untuk diperiksa.

Mengembalikan

createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)

Tambahkan grup konsumen ke titik akhir yang kompatibel dengan Event Hub di hub IoT.

function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, consumerGroupBody: EventHubConsumerGroupBodyDescription, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

eventHubEndpointName

string

Nama titik akhir yang kompatibel dengan Pusat Aktivitas di hub IoT.

name

string

Nama grup konsumen yang akan ditambahkan.

consumerGroupBody
EventHubConsumerGroupBodyDescription

Grup konsumen yang akan ditambahkan.

Mengembalikan

deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)

Menghapus grup konsumen dari titik akhir yang kompatibel dengan Event Hub di hub IoT.

function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

eventHubEndpointName

string

Nama titik akhir yang kompatibel dengan Pusat Aktivitas di hub IoT.

name

string

Nama grup konsumen yang akan dihapus.

Mengembalikan

Promise<void>

exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)

Mengekspor semua identitas perangkat di registri identitas hub IoT ke kontainer blob Azure Storage. Untuk informasi selengkapnya, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

function exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: ExportDevicesRequest, options?: IotHubResourceExportDevicesOptionalParams): Promise<JobResponse>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

exportDevicesParameters
ExportDevicesRequest

Parameter yang menentukan operasi perangkat ekspor.

Mengembalikan

Promise<JobResponse>

get(string, string, IotHubResourceGetOptionalParams)

Dapatkan metadata terkait non-keamanan dari hub IoT.

function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

options
IotHubResourceGetOptionalParams

Parameter opsi.

Mengembalikan

getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)

Dapatkan grup konsumen dari titik akhir perangkat-ke-cloud yang kompatibel dengan Event Hub untuk hub IoT.

function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

eventHubEndpointName

string

Nama titik akhir yang kompatibel dengan Pusat Aktivitas di hub IoT.

name

string

Nama grup konsumen yang akan diambil.

Mengembalikan

getJob(string, string, string, IotHubResourceGetJobOptionalParams)

Dapatkan detail pekerjaan dari hub IoT. Untuk informasi selengkapnya, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

jobId

string

Pengidentifikasi pekerjaan.

options
IotHubResourceGetJobOptionalParams

Parameter opsi.

Mengembalikan

Promise<JobResponse>

getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)

Dapatkan kebijakan akses bersama berdasarkan nama dari hub IoT. Untuk informasi selengkapnya, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

keyName

string

Nama kebijakan akses bersama.

Mengembalikan

getStats(string, string, IotHubResourceGetStatsOptionalParams)

Dapatkan statistik dari hub IoT.

function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

options
IotHubResourceGetStatsOptionalParams

Parameter opsi.

Mengembalikan

importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)

Mengimpor, memperbarui, atau menghapus identitas perangkat di registri identitas hub IoT dari blob. Untuk informasi selengkapnya, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

function importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: ImportDevicesRequest, options?: IotHubResourceImportDevicesOptionalParams): Promise<JobResponse>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

importDevicesParameters
ImportDevicesRequest

Parameter yang menentukan operasi impor perangkat.

Mengembalikan

Promise<JobResponse>

listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)

Dapatkan semua hub IoT dalam grup sumber daya.

function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

Mengembalikan

listBySubscription(IotHubResourceListBySubscriptionOptionalParams)

Dapatkan semua hub IoT dalam langganan.

function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>

Parameter

Mengembalikan

listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)

Dapatkan kesehatan untuk titik akhir perutean.

function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>

Parameter

resourceGroupName

string

iotHubName

string

Mengembalikan

listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)

Dapatkan daftar grup konsumen di titik akhir perangkat-ke-cloud yang kompatibel dengan Event Hub di hub IoT.

function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

eventHubEndpointName

string

Nama titik akhir yang kompatibel dengan Pusat Aktivitas.

Mengembalikan

listJobs(string, string, IotHubResourceListJobsOptionalParams)

Dapatkan daftar semua pekerjaan di hub IoT. Untuk informasi selengkapnya, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

options
IotHubResourceListJobsOptionalParams

Parameter opsi.

Mengembalikan

listKeys(string, string, IotHubResourceListKeysOptionalParams)

Dapatkan metadata keamanan untuk hub IoT. Untuk informasi selengkapnya, lihat: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

options
IotHubResourceListKeysOptionalParams

Parameter opsi.

Mengembalikan

listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)

Dapatkan metrik kuota untuk hub IoT.

function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

Mengembalikan

listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)

Dapatkan daftar SKU yang valid untuk hub IoT.

function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi hub IoT.

resourceName

string

Nama hub IoT.

Mengembalikan

testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)

Uji semua rute yang dikonfigurasi di Iot Hub ini

function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>

Parameter

iotHubName

string

IotHub yang akan diuji

resourceGroupName

string

grup sumber daya tempat Iot Hub berada

input
TestAllRoutesInput

Input untuk menguji semua rute

Mengembalikan

testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)

Uji rute baru untuk Iot Hub ini

function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>

Parameter

iotHubName

string

IotHub yang akan diuji

resourceGroupName

string

grup sumber daya tempat Iot Hub berada

input
TestRouteInput

Rute yang perlu diuji

options
IotHubResourceTestRouteOptionalParams

Parameter opsi.

Mengembalikan

Promise<TestRouteResult>