Sdílet prostřednictvím


IotHubResource interface

Rozhraní představující IotHubResource.

Metody

beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)

Vytvořte nebo aktualizujte metadata služby Iot Hub. Obvyklým vzorem pro úpravu vlastnosti je načtení metadat a metadat zabezpečení služby IoT Hub a jejich následné kombinování se změněnými hodnotami v novém textu, aby se aktualizovalo centrum IoT. Pokud ve formátu JSON chybí určité vlastnosti, aktualizace IoT Hub může způsobit, že se tyto hodnoty převedou na výchozí, což může vést k neočekávanému chování.

beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)

Vytvořte nebo aktualizujte metadata služby Iot Hub. Obvyklým vzorem pro úpravu vlastnosti je načtení metadat a metadat zabezpečení služby IoT Hub a jejich následné kombinování se změněnými hodnotami v novém textu, aby se aktualizovalo centrum IoT. Pokud ve formátu JSON chybí určité vlastnosti, aktualizace IoT Hub může způsobit, že se tyto hodnoty převedou na výchozí, což může vést k neočekávanému chování.

beginDelete(string, string, IotHubResourceDeleteOptionalParams)

Odstraňte centrum IoT.

beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)

Odstraňte centrum IoT.

beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)

Aktualizujte existující značky IoT Hub. Pokud chcete aktualizovat další pole, použijte metodu CreateOrUpdate.

beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)

Aktualizujte existující značky IoT Hub. Pokud chcete aktualizovat další pole, použijte metodu CreateOrUpdate.

checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)

Zkontrolujte, jestli je k dispozici název centra IoT.

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

Přidejte skupinu příjemců do koncového bodu kompatibilního se službou Event Hub ve službě IoT Hub.

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

Odstraňte skupinu příjemců z koncového bodu kompatibilního s centrem událostí ve službě IoT Hub.

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.

get(string, string, IotHubResourceGetOptionalParams)

Získejte metadata IoT Hubu, která nesouvisí se zabezpečením.

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

Získejte skupinu příjemců z koncového bodu zařízení-cloud kompatibilního s centrem událostí pro IoT Hub.

getJob(string, string, string, IotHubResourceGetJobOptionalParams)

Získejte podrobnosti o úloze ze služby IoT Hub. Další informace najdete v tématu: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)

Získejte zásady sdíleného přístupu podle názvu ze služby IoT Hub. Další informace najdete v tématu: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

getStats(string, string, IotHubResourceGetStatsOptionalParams)

Získejte statistiky ze služby IoT Hub.

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.

listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)

Získejte všechna centra IoT ve skupině prostředků.

listBySubscription(IotHubResourceListBySubscriptionOptionalParams)

Získejte všechna centra IoT v předplatném.

listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)

Získejte stav koncových bodů směrování.

listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)

Získejte seznam skupin příjemců v koncovém bodu zařízení-cloud kompatibilní s centrem událostí ve službě IoT Hub.

listJobs(string, string, IotHubResourceListJobsOptionalParams)

Získejte seznam všech úloh ve službě IoT Hub. Další informace najdete v tématu: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

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.

listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)

Získejte metriky kvót pro centrum IoT.

listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)

Získejte seznam platných skladových položek pro centrum IoT.

testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)

Testování všech tras nakonfigurovaných v tomto iot Hubu

testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)

Testování nové trasy pro tuto službu Iot Hub

Podrobnosti metody

beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)

Vytvořte nebo aktualizujte metadata služby Iot Hub. Obvyklým vzorem pro úpravu vlastnosti je načtení metadat a metadat zabezpečení služby IoT Hub a jejich následné kombinování se změněnými hodnotami v novém textu, aby se aktualizovalo centrum IoT. Pokud ve formátu JSON chybí určité vlastnosti, aktualizace IoT Hub může způsobit, že se tyto hodnoty převedou na výchozí, což může vést k neočekávanému chování.

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

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje centrum IoT.

resourceName

string

Název centra IoT.

iotHubDescription
IotHubDescription

Metadata služby IoT Hub a metadata zabezpečení.

options
IotHubResourceCreateOrUpdateOptionalParams

Parametry možností

Návraty

Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>

beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)

Vytvořte nebo aktualizujte metadata služby Iot Hub. Obvyklým vzorem pro úpravu vlastnosti je načtení metadat a metadat zabezpečení služby IoT Hub a jejich následné kombinování se změněnými hodnotami v novém textu, aby se aktualizovalo centrum IoT. Pokud ve formátu JSON chybí určité vlastnosti, aktualizace IoT Hub může způsobit, že se tyto hodnoty převedou na výchozí, 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 centra IoT.

iotHubDescription
IotHubDescription

Metadata služby IoT Hub a metadata zabezpečení.

options
IotHubResourceCreateOrUpdateOptionalParams

Parametry možností

Návraty

beginDelete(string, string, IotHubResourceDeleteOptionalParams)

Odstraňte centrum IoT.

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

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje centrum IoT.

resourceName

string

Název centra IoT.

options
IotHubResourceDeleteOptionalParams

Parametry možností

Návraty

Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>

beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)

Odstraňte centrum IoT.

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 centra IoT.

options
IotHubResourceDeleteOptionalParams

Parametry možností

Návraty

beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)

Aktualizujte existující značky IoT Hub. Pokud chcete aktualizovat další pole, použijte metodu CreateOrUpdate.

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

Parametry

resourceGroupName

string

Identifikátor skupiny prostředků.

resourceName

string

Název iot Hubu, který se má aktualizovat.

iotHubTags
TagsResource

Aktualizovali jsme informace o značkách, které se mají nastavit do instance iot Hubu.

options
IotHubResourceUpdateOptionalParams

Parametry možností

Návraty

Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>

beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)

Aktualizujte existující značky IoT Hub. Pokud chcete aktualizovat další pole, 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

Aktualizovali jsme informace o značkách, které se mají nastavit do instance iot Hubu.

options
IotHubResourceUpdateOptionalParams

Parametry možností

Návraty

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.

Návraty

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

Přidejte skupinu příjemců do koncového bodu kompatibilního se službou Event Hub ve službě IoT Hub.

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

Parametry

resourceGroupName

string

Název skupiny prostředků, která obsahuje centrum IoT.

resourceName

string

Název centra IoT.

eventHubEndpointName

string

Název koncového bodu kompatibilního se službou Event Hub ve službě IoT Hub.

name

string

Název skupiny příjemců, kterou chcete přidat.

Návraty

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

Odstraňte skupinu příjemců z koncového bodu kompatibilního s centrem událostí ve službě IoT Hub.

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 centra IoT.

eventHubEndpointName

string

Název koncového bodu kompatibilního se službou Event Hub ve službě IoT Hub.

name

string

Název skupiny příjemců, kterou chcete odstranit.

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 centra IoT.

exportDevicesParameters
ExportDevicesRequest

Parametry, které určují operaci exportu zařízení.

options
IotHubResourceExportDevicesOptionalParams

Parametry možností

Návraty

Promise<JobResponse>

get(string, string, IotHubResourceGetOptionalParams)

Získejte metadata IoT Hubu, která nesouvisí se zabezpečením.

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 centra IoT.

options
IotHubResourceGetOptionalParams

Parametry možností

Návraty

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

Získejte skupinu příjemců z koncového bodu zařízení-cloud kompatibilního s centrem událostí pro IoT Hub.

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 centra IoT.

eventHubEndpointName

string

Název koncového bodu kompatibilního se službou Event Hub ve službě IoT Hub.

name

string

Název skupiny příjemců, která se má načíst.

Návraty

getJob(string, string, string, IotHubResourceGetJobOptionalParams)

Získejte podrobnosti o úloze ze služby IoT Hub. 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 centra IoT.

jobId

string

Identifikátor úlohy.

options
IotHubResourceGetJobOptionalParams

Parametry možností

Návraty

Promise<JobResponse>

getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)

Získejte zásady sdíleného přístupu podle názvu ze služby IoT Hub. 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 centra IoT.

keyName

string

Název zásady sdíleného přístupu.

options
IotHubResourceGetKeysForKeyNameOptionalParams

Parametry možností

Návraty

getStats(string, string, IotHubResourceGetStatsOptionalParams)

Získejte statistiky ze služby IoT Hub.

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 centra IoT.

options
IotHubResourceGetStatsOptionalParams

Parametry možností

Návraty

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 centra IoT.

importDevicesParameters
ImportDevicesRequest

Parametry, které určují operaci importu zařízení.

options
IotHubResourceImportDevicesOptionalParams

Parametry možností

Návraty

Promise<JobResponse>

listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)

Získejte všechna centra IoT 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.

Návraty

listBySubscription(IotHubResourceListBySubscriptionOptionalParams)

Získejte všechna centra IoT v předplatném.

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

Parametry

options
IotHubResourceListBySubscriptionOptionalParams

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

options
IotHubResourceGetEndpointHealthOptionalParams

Parametry možností

Návraty

listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)

Získejte seznam skupin příjemců v koncovém bodu zařízení-cloud kompatibilní s centrem událostí ve službě IoT Hub.

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 centra IoT.

eventHubEndpointName

string

Název koncového bodu kompatibilního s centrem událostí.

Návraty

listJobs(string, string, IotHubResourceListJobsOptionalParams)

Získejte seznam všech úloh ve službě IoT Hub. 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 centra IoT.

options
IotHubResourceListJobsOptionalParams

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 centra IoT.

options
IotHubResourceListKeysOptionalParams

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 centra IoT.

options
IotHubResourceGetQuotaMetricsOptionalParams

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 centra IoT.

options
IotHubResourceGetValidSkusOptionalParams

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 k testování

resourceGroupName

string

skupina prostředků, do které iot Hub patří

input
TestAllRoutesInput

Vstup pro testování všech tras

options
IotHubResourceTestAllRoutesOptionalParams

Parametry možností

Návraty

testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)

Testová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 k testování

resourceGroupName

string

skupina prostředků, do které iot Hub patří

input
TestRouteInput

Trasa, kterou je potřeba otestovat

options
IotHubResourceTestRouteOptionalParams

Parametry možností

Návraty

Promise<TestRouteResult>