IotHubResource interface
Antarmuka yang mewakili IotHubResource.
Metode
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.
Parameter opsi.
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.
Parameter opsi.
Mengembalikan
Promise<IotHubDescription>
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.
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.
Parameter opsi.
Mengembalikan
Promise<IotHubDescription>
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.
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.
Parameter opsi.
Mengembalikan
Promise<IotHubDescription>
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.
Parameter opsi.
Mengembalikan
Promise<IotHubNameAvailabilityInfo>
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.
Parameter opsi.
Mengembalikan
Promise<EventHubConsumerGroupInfo>
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.
Parameter opsi.
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.
Parameter opsi.
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
Promise<IotHubDescription>
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.
Parameter opsi.
Mengembalikan
Promise<EventHubConsumerGroupInfo>
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.
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.
Parameter opsi.
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.
Parameter opsi.
Mengembalikan
Promise<RegistryStatistics>
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.
Parameter opsi.
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.
Parameter opsi.
Mengembalikan
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
Dapatkan semua hub IoT dalam langganan.
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Parameter
Parameter opsi.
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
Parameter opsi.
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.
Parameter opsi.
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.
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.
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.
Parameter opsi.
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.
Parameter opsi.
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
Parameter opsi.
Mengembalikan
Promise<TestAllRoutesResult>
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
Parameter opsi.
Mengembalikan
Promise<TestRouteResult>