IotHubResource interface
IotHubResource-t képviselő felület.
Metódusok
Metódus adatai
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Iot Hub metaadatainak létrehozása vagy frissítése. A tulajdonság módosításának szokásos módja az IoT Hub metaadatainak és biztonsági metaadatainak lekérése, majd az új törzs módosított értékeinek kombinálása az IoT Hub frissítéséhez. Ha bizonyos tulajdonságok hiányoznak a JSON-ban, az IoT Hub frissítése miatt ezek az értékek alapértelmezés szerint visszaeshetnek, ami váratlan működéshez vezethet.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
- iotHubDescription
- IotHubDescription
Az IoT Hub metaadatai és biztonsági metaadatai.
A beállítások paraméterei.
Válaszok
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Iot Hub metaadatainak létrehozása vagy frissítése. A tulajdonság módosításának szokásos módja az IoT Hub metaadatainak és biztonsági metaadatainak lekérése, majd az új törzs módosított értékeinek kombinálása az IoT Hub frissítéséhez. Ha bizonyos tulajdonságok hiányoznak a JSON-ban, az IoT Hub frissítése miatt ezek az értékek alapértelmezés szerint visszaeshetnek, ami váratlan működéshez vezethet.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
- iotHubDescription
- IotHubDescription
Az IoT Hub metaadatai és biztonsági metaadatai.
A beállítások paraméterei.
Válaszok
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
IoT Hub törlése.
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
A beállítások paraméterei.
Válaszok
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
IoT Hub törlése.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
A beállítások paraméterei.
Válaszok
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Meglévő IoT Hub-címkék frissítése. más mezők frissítéséhez használja a CreateOrUpdate metódust
function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Paraméterek
- resourceGroupName
-
string
Erőforráscsoport azonosítója.
- resourceName
-
string
A frissíteni kívánt iot hub neve.
- iotHubTags
- TagsResource
Frissített címkeinformációk az iot hub-példányra való beállításhoz.
A beállítások paraméterei.
Válaszok
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Meglévő IoT Hub-címkék frissítése. más mezők frissítéséhez használja a CreateOrUpdate metódust
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>
Paraméterek
- resourceGroupName
-
string
Erőforráscsoport azonosítója.
- resourceName
-
string
A frissíteni kívánt iot hub neve.
- iotHubTags
- TagsResource
Frissített címkeinformációk az iot hub-példányra való beállításhoz.
A beállítások paraméterei.
Válaszok
Promise<IotHubDescription>
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)
Ellenőrizze, hogy elérhető-e IoT Hub-név.
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>
Paraméterek
- operationInputs
- OperationInputs
Állítsa az OperationInputs struktúra névparaméterét az ellenőrizni kívánt IoT Hub nevére.
A beállítások paraméterei.
Válaszok
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
Adjon hozzá egy fogyasztói csoportot egy Event Hub-kompatibilis végponthoz egy IoT Hubban.
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, consumerGroupBody: EventHubConsumerGroupBodyDescription, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
- eventHubEndpointName
-
string
Az Event Hub-kompatibilis végpont neve az IoT Hubban.
- name
-
string
A hozzáadni kívánt fogyasztói csoport neve.
- consumerGroupBody
- EventHubConsumerGroupBodyDescription
A hozzáadni kívánt fogyasztói csoport.
A beállítások paraméterei.
Válaszok
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
Egy fogyasztói csoport törlése egy Event Hub-kompatibilis végpontról egy IoT Hubban.
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
- eventHubEndpointName
-
string
Az Event Hub-kompatibilis végpont neve az IoT Hubban.
- name
-
string
A törölni kívánt fogyasztói csoport neve.
A beállítások paraméterei.
Válaszok
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
Exportálja az IoT Hub identitásjegyzékében található összes eszközidentitást egy Azure Storage-blobtárolóba. További információ: 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>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
- exportDevicesParameters
- ExportDevicesRequest
Az exportálási eszközök műveletet meghatározó paraméterek.
A beállítások paraméterei.
Válaszok
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
IoT Hub nem biztonsággal kapcsolatos metaadatainak lekérése.
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
- options
- IotHubResourceGetOptionalParams
A beállítások paraméterei.
Válaszok
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
Egy fogyasztói csoport lekérése az Event Hub-kompatibilis eszközről a felhőbe végpontról egy IoT Hubhoz.
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
- eventHubEndpointName
-
string
Az Event Hub-kompatibilis végpont neve az IoT Hubban.
- name
-
string
A lekérni kívánt fogyasztói csoport neve.
A beállítások paraméterei.
Válaszok
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
Lekérheti egy feladat részleteit egy IoT Hubról. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
- jobId
-
string
A feladat azonosítója.
A beállítások paraméterei.
Válaszok
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
Közös hozzáférési szabályzat lekérése név szerint egy IoT Hubról. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
- keyName
-
string
A megosztott hozzáférési szabályzat neve.
A beállítások paraméterei.
Válaszok
getStats(string, string, IotHubResourceGetStatsOptionalParams)
A statisztikák lekérése egy IoT-központból.
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
A beállítások paraméterei.
Válaszok
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
Eszközidentitások importálása, frissítése vagy törlése az IoT Hub identitásjegyzékében egy blobból. További információ: 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>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
- importDevicesParameters
- ImportDevicesRequest
Az importálási eszközök műveletet meghatározó paraméterek.
A beállítások paraméterei.
Válaszok
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
Szerezze be az összes IoT Hubot egy erőforráscsoportban.
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
A beállítások paraméterei.
Válaszok
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
Szerezze be az összes IoT Hubot egy előfizetésben.
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Paraméterek
A beállítások paraméterei.
Válaszok
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)
Az útválasztási végpontok állapotának lekérése.
function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>
Paraméterek
- resourceGroupName
-
string
- iotHubName
-
string
A beállítások paraméterei.
Válaszok
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)
Lekérheti a fogyasztói csoportok listáját egy IoT Hub Event Hub-kompatibilis eszközről felhőbe végpontjára.
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
- eventHubEndpointName
-
string
Az Event Hub-kompatibilis végpont neve.
A beállítások paraméterei.
Válaszok
listJobs(string, string, IotHubResourceListJobsOptionalParams)
Lekérheti az IoT Hub összes feladatának listáját. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
A beállítások paraméterei.
Válaszok
listKeys(string, string, IotHubResourceListKeysOptionalParams)
Az IoT Hub biztonsági metaadatainak lekérése. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
A beállítások paraméterei.
Válaszok
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
Az IoT Hub kvótametrikáinak lekérése.
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
A beállítások paraméterei.
Válaszok
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
Szerezze be egy IoT Hub érvényes termékváltozatainak listáját.
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>
Paraméterek
- resourceGroupName
-
string
Az IoT Hubot tartalmazó erőforráscsoport neve.
- resourceName
-
string
Az IoT Hub neve.
A beállítások paraméterei.
Válaszok
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
Az Iot Hubban konfigurált összes útvonal tesztelése
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>
Paraméterek
- iotHubName
-
string
Tesztelendő IotHub
- resourceGroupName
-
string
erőforráscsoport, amelyhez az Iot Hub tartozik
- input
- TestAllRoutesInput
Bemenet az összes útvonal teszteléséhez
A beállítások paraméterei.
Válaszok
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
Az Iot Hub új útvonalának tesztelése
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>
Paraméterek
- iotHubName
-
string
Tesztelendő IotHub
- resourceGroupName
-
string
erőforráscsoport, amelyhez az Iot Hub tartozik
- input
- TestRouteInput
Tesztelni kívánt útvonal
A beállítások paraméterei.
Válaszok
Promise<TestRouteResult>