IotHubResource interface
Rozhraní představující IotHubResource
Metody
Podrobnosti metody
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Vytvořte nebo aktualizujte metadata centra IoT. Obvyklým způsobem úpravy vlastnosti je načtení metadat a metadat zabezpečení služby IoT Hub a jejich následné kombinování s upravenými hodnotami v novém textu za účelem aktualizace ioT Hubu. Pokud ve formátu JSON chybí některé vlastnosti, může aktualizace služby IoT Hub způsobit, že se tyto hodnoty převedou do výchozího stavu, což může vést k neočekávanému chování.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
- iotHubDescription
- IotHubDescription
Metadata služby IoT Hub a metadata zabezpečení.
Parametry možností.
Návraty
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
Vytvořte nebo aktualizujte metadata centra IoT. Obvyklým způsobem úpravy vlastnosti je načtení metadat a metadat zabezpečení služby IoT Hub a jejich následné kombinování s upravenými hodnotami v novém textu za účelem aktualizace ioT Hubu. Pokud ve formátu JSON chybí některé vlastnosti, může aktualizace služby IoT Hub způsobit, že se tyto hodnoty převedou do výchozího stavu, což může vést k neočekávanému chování.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
- iotHubDescription
- IotHubDescription
Metadata služby IoT Hub a metadata zabezpečení.
Parametry možností.
Návraty
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
Odstranění ioT Hubu
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
Parametry možností.
Návraty
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
Odstranění ioT Hubu
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
Parametry možností.
Návraty
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Aktualizujte existující značky ioT Hubu. k aktualizaci dalších polí použijte metodu CreateOrUpdate.
function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
Parametry
- resourceGroupName
-
string
Identifikátor skupiny prostředků.
- resourceName
-
string
Název iot Hubu, který se má aktualizovat.
- iotHubTags
- TagsResource
Aktualizace informací o značkách pro nastavení do instance iot Hubu
Parametry možností.
Návraty
Promise<@azure/core-lro.SimplePollerLike<OperationState<IotHubDescription>, IotHubDescription>>
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Aktualizujte existující značky ioT Hubu. k aktualizaci dalších polí použijte metodu CreateOrUpdate.
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>
Parametry
- resourceGroupName
-
string
Identifikátor skupiny prostředků.
- resourceName
-
string
Název iot Hubu, který se má aktualizovat.
- iotHubTags
- TagsResource
Aktualizace informací o značkách pro nastavení do instance iot Hubu
Parametry možností.
Návraty
Promise<IotHubDescription>
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)
Zkontrolujte, jestli je k dispozici název centra IoT.
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>
Parametry
- operationInputs
- OperationInputs
Nastavte parametr name ve struktuře OperationInputs na název centra IoT, který chcete zkontrolovat.
Parametry možností.
Návraty
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
Přidejte skupinu příjemců do koncového bodu kompatibilního s centrem událostí v centru IoT.
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, consumerGroupBody: EventHubConsumerGroupBodyDescription, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
- eventHubEndpointName
-
string
Název koncového bodu kompatibilního s centrem událostí v centru IoT.
- name
-
string
Název skupiny příjemců, která se má přidat.
- consumerGroupBody
- EventHubConsumerGroupBodyDescription
Skupina příjemců, která se má přidat.
Parametry možností.
Návraty
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
Odstraňte skupinu příjemců z koncového bodu kompatibilního s centrem událostí v centru IoT.
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
- eventHubEndpointName
-
string
Název koncového bodu kompatibilního s centrem událostí v centru IoT.
- name
-
string
Název skupiny příjemců, která se má odstranit.
Parametry možností.
Návraty
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
Exportuje všechny identity zařízení v registru identit služby IoT Hub do kontejneru objektů blob služby Azure Storage. Další informace najdete v tématu: 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>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
- exportDevicesParameters
- ExportDevicesRequest
Parametry, které určují operaci exportu zařízení.
Parametry možností.
Návraty
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
Získejte metadata nesouvisená se zabezpečením centra IoT.
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
- options
- IotHubResourceGetOptionalParams
Parametry možností.
Návraty
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
Získejte skupinu příjemců z koncového bodu zařízení kompatibilního se službou Event Hub-cloud pro centrum IoT.
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
- eventHubEndpointName
-
string
Název koncového bodu kompatibilního s centrem událostí v centru IoT.
- name
-
string
Název skupiny příjemců, která se má načíst.
Parametry možností.
Návraty
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
Získejte podrobnosti o úloze z IoT Hubu. Další informace najdete v tématu: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
- jobId
-
string
Identifikátor úlohy.
Parametry možností.
Návraty
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
Získejte zásadu sdíleného přístupu podle názvu z centra IoT. Další informace najdete v tématu: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
- keyName
-
string
Název zásady sdíleného přístupu.
Parametry možností.
Návraty
getStats(string, string, IotHubResourceGetStatsOptionalParams)
Získejte statistiky z centra IoT.
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
Parametry možností.
Návraty
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
Importujte, aktualizujte nebo odstraňte identity zařízení v registru identit služby IoT Hub z objektu blob. Další informace najdete v tématu: 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>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
- importDevicesParameters
- ImportDevicesRequest
Parametry, které určují operaci importu zařízení.
Parametry možností.
Návraty
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
Získejte všechny služby IoT Hub ve skupině prostředků.
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
Parametry možností.
Návraty
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
Získejte všechna centra IoT v předplatném.
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>
Parametry
Parametry možností.
Návraty
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)
Získejte stav koncových bodů směrování.
function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>
Parametry
- resourceGroupName
-
string
- iotHubName
-
string
Parametry možností.
Návraty
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)
Získejte seznam skupin příjemců v koncovém bodu zařízení kompatibilním se službou Event Hub-cloud v centru IoT.
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
- eventHubEndpointName
-
string
Název koncového bodu kompatibilního s centrem událostí.
Parametry možností.
Návraty
listJobs(string, string, IotHubResourceListJobsOptionalParams)
Získejte seznam všech úloh v Centru IoT. Další informace najdete v tématu: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
Parametry možností.
Návraty
listKeys(string, string, IotHubResourceListKeysOptionalParams)
Získejte metadata zabezpečení pro centrum IoT. Další informace najdete v tématu: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
Parametry možností.
Návraty
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
Získejte metriky kvót pro centrum IoT.
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
Parametry možností.
Návraty
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
Získejte seznam platných skladových položek pro centrum IoT.
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje centrum IoT.
- resourceName
-
string
Název ioT Hubu.
Parametry možností.
Návraty
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
Testování všech tras nakonfigurovaných v tomto iot Hubu
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>
Parametry
- iotHubName
-
string
IotHub, který se má testovat
- resourceGroupName
-
string
skupina prostředků, do které iot Hub patří
- input
- TestAllRoutesInput
Vstup pro testování všech tras
Parametry možností.
Návraty
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
Otestování nové trasy pro tuto službu Iot Hub
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>
Parametry
- iotHubName
-
string
IotHub, který se má testovat
- resourceGroupName
-
string
skupina prostředků, do které iot Hub patří
- input
- TestRouteInput
Trasa, která se musí testovat
Parametry možností.
Návraty
Promise<TestRouteResult>