IotHubResource interface

Paket:

@azure/arm-iothub

Schnittstelle, die eine IotHubResource darstellt.

Methoden

beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)	Erstellen oder aktualisieren Sie die Metadaten eines Iot-Hubs. Das übliche Muster zum Ändern einer Eigenschaft besteht darin, die IoT-Hubmetadaten und Sicherheitsmetadaten abzurufen und sie dann mit den geänderten Werten in einem neuen Text zu kombinieren, um den IoT-Hub zu aktualisieren. Wenn bestimmte Eigenschaften im JSON fehlen, kann das Aktualisieren von IoT Hub dazu führen, dass diese Werte auf den Standardwert zurückfallen, was zu unerwartetem Verhalten führen kann.
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)	Erstellen oder aktualisieren Sie die Metadaten eines Iot-Hubs. Das übliche Muster zum Ändern einer Eigenschaft besteht darin, die IoT-Hubmetadaten und Sicherheitsmetadaten abzurufen und sie dann mit den geänderten Werten in einem neuen Text zu kombinieren, um den IoT-Hub zu aktualisieren. Wenn bestimmte Eigenschaften im JSON fehlen, kann das Aktualisieren von IoT Hub dazu führen, dass diese Werte auf den Standardwert zurückfallen, was zu unerwartetem Verhalten führen kann.
beginDelete(string, string, IotHubResourceDeleteOptionalParams)	Löschen Sie einen IoT-Hub.
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)	Löschen Sie einen IoT-Hub.
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)	Aktualisieren Sie eine vorhandene IoT Hub-Tags. um andere Felder zu aktualisieren, verwenden Sie die CreateOrUpdate-Methode
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)	Aktualisieren Sie eine vorhandene IoT Hub-Tags. um andere Felder zu aktualisieren, verwenden Sie die CreateOrUpdate-Methode
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)	Überprüfen Sie, ob ein IoT-Hubname verfügbar ist.
createEventHubConsumerGroup(string, string, string, string, EventHubConsumerGroupBodyDescription, IotHubResourceCreateEventHubConsumerGroupOptionalParams)	Fügen Sie einer Consumergruppe einen event Hub-kompatiblen Endpunkt in einem IoT-Hub hinzu.
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)	Löschen sie eine Consumergruppe von einem Event Hub-kompatiblen Endpunkt in einem IoT-Hub.
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)	Exportiert alle Geräteidentitäten in der IoT Hub-Identitätsregistrierung in einen Azure Storage-BLOB-Container. Weitere Informationen finden Sie unter: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
get(string, string, IotHubResourceGetOptionalParams)	Rufen Sie die nicht sicherheitsrelevanten Metadaten eines IoT-Hubs ab.
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)	Rufen Sie eine Consumergruppe vom Event Hub-kompatiblen Geräte-zu-Cloud-Endpunkt für einen IoT-Hub ab.
getJob(string, string, string, IotHubResourceGetJobOptionalParams)	Rufen Sie die Details eines Auftrags von einem IoT-Hub ab. Weitere Informationen finden Sie unter: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)	Rufen Sie eine freigegebene Zugriffsrichtlinie anhand des Namens von einem IoT-Hub ab. Weitere Informationen finden Sie unter: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
getStats(string, string, IotHubResourceGetStatsOptionalParams)	Rufen Sie die Statistiken von einem IoT-Hub ab.
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)	Importieren, Aktualisieren oder Löschen von Geräteidentitäten in der IoT Hub-Identitätsregistrierung aus einem BLOB. Weitere Informationen finden Sie unter: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)	Rufen Sie alle IoT-Hubs in einer Ressourcengruppe ab.
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)	Rufen Sie alle IoT-Hubs in einem Abonnement ab.
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)	Rufen Sie die Integrität für Routingendpunkte ab.
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)	Rufen Sie eine Liste der Consumergruppen im Event Hub-kompatiblen Geräte-zu-Cloud-Endpunkt in einem IoT-Hub ab.
listJobs(string, string, IotHubResourceListJobsOptionalParams)	Dient zum Abrufen einer Liste aller Aufträge in einem IoT-Hub. Weitere Informationen finden Sie unter: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
listKeys(string, string, IotHubResourceListKeysOptionalParams)	Rufen Sie die Sicherheitsmetadaten für einen IoT-Hub ab. Weitere Informationen finden Sie unter: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)	Rufen Sie die Kontingentmetriken für einen IoT-Hub ab.
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)	Ruft die Liste der gültigen SKUs für einen IoT-Hub ab.
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)	Testen aller Routen, die in diesem Iot Hub konfiguriert sind
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)	Testen der neuen Route für diesen Iot Hub

Details zur Methode

beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)

Erstellen oder aktualisieren Sie die Metadaten eines Iot-Hubs. Das übliche Muster zum Ändern einer Eigenschaft besteht darin, die IoT-Hubmetadaten und Sicherheitsmetadaten abzurufen und sie dann mit den geänderten Werten in einem neuen Text zu kombinieren, um den IoT-Hub zu aktualisieren. Wenn bestimmte Eigenschaften im JSON fehlen, kann das Aktualisieren von IoT Hub dazu führen, dass diese Werte auf den Standardwert zurückfallen, was zu unerwartetem Verhalten führen kann.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

iotHubDescription

IotHubDescription

Die IoT-Hubmetadaten und Sicherheitsmetadaten.

options

IotHubResourceCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)

Erstellen oder aktualisieren Sie die Metadaten eines Iot-Hubs. Das übliche Muster zum Ändern einer Eigenschaft besteht darin, die IoT-Hubmetadaten und Sicherheitsmetadaten abzurufen und sie dann mit den geänderten Werten in einem neuen Text zu kombinieren, um den IoT-Hub zu aktualisieren. Wenn bestimmte Eigenschaften im JSON fehlen, kann das Aktualisieren von IoT Hub dazu führen, dass diese Werte auf den Standardwert zurückfallen, was zu unerwartetem Verhalten führen kann.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

iotHubDescription

IotHubDescription

Die IoT-Hubmetadaten und Sicherheitsmetadaten.

options

IotHubResourceCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<IotHubDescription>

beginDelete(string, string, IotHubResourceDeleteOptionalParams)

Löschen Sie einen IoT-Hub.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

options

IotHubResourceDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)

Löschen Sie einen IoT-Hub.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

options

IotHubResourceDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<IotHubDescription>

beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)

Aktualisieren Sie eine vorhandene IoT Hub-Tags. um andere Felder zu aktualisieren, verwenden Sie die CreateOrUpdate-Methode

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

Parameter

resourceGroupName

string

Ressourcengruppenbezeichner.

resourceName

string

Name des zu aktualisierenden Iot-Hubs.

iotHubTags

TagsResource

Aktualisierte Taginformationen, die in die Iot-Hubinstanz festgelegt werden sollen.

options

IotHubResourceUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)

Aktualisieren Sie eine vorhandene IoT Hub-Tags. um andere Felder zu aktualisieren, verwenden Sie die CreateOrUpdate-Methode

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

Parameter

resourceGroupName

string

Ressourcengruppenbezeichner.

resourceName

string

Name des zu aktualisierenden Iot-Hubs.

iotHubTags

TagsResource

Aktualisierte Taginformationen, die in die Iot-Hubinstanz festgelegt werden sollen.

options

IotHubResourceUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<IotHubDescription>

checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)

Überprüfen Sie, ob ein IoT-Hubname verfügbar ist.

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

Parameter

operationInputs

OperationInputs

Legen Sie den Namensparameter in der OperationInputs-Struktur auf den Namen des zu überprüfenden IoT-Hubs fest.

options

IotHubResourceCheckNameAvailabilityOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<IotHubNameAvailabilityInfo>

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

Fügen Sie einer Consumergruppe einen event Hub-kompatiblen Endpunkt in einem IoT-Hub hinzu.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

eventHubEndpointName

string

Der Name des event Hub-kompatiblen Endpunkts im IoT-Hub.

name

string

Der Name der hinzuzufügenden Consumergruppe.

consumerGroupBody

EventHubConsumerGroupBodyDescription

Die hinzuzufügende Consumergruppe.

options

IotHubResourceCreateEventHubConsumerGroupOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<EventHubConsumerGroupInfo>

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

Löschen sie eine Consumergruppe von einem Event Hub-kompatiblen Endpunkt in einem IoT-Hub.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

eventHubEndpointName

string

Der Name des event Hub-kompatiblen Endpunkts im IoT-Hub.

name

string

Der Name der zu löschenden Consumergruppe.

options

IotHubResourceDeleteEventHubConsumerGroupOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)

Exportiert alle Geräteidentitäten in der IoT Hub-Identitätsregistrierung in einen Azure Storage-BLOB-Container. Weitere Informationen finden Sie unter: 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

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

exportDevicesParameters

ExportDevicesRequest

Die Parameter, die den Exportgerätevorgang angeben.

options

IotHubResourceExportDevicesOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<JobResponse>

get(string, string, IotHubResourceGetOptionalParams)

Rufen Sie die nicht sicherheitsrelevanten Metadaten eines IoT-Hubs ab.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

options

IotHubResourceGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<IotHubDescription>

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

Rufen Sie eine Consumergruppe vom Event Hub-kompatiblen Geräte-zu-Cloud-Endpunkt für einen IoT-Hub ab.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

eventHubEndpointName

string

Der Name des event Hub-kompatiblen Endpunkts im IoT-Hub.

name

string

Der Name der abzurufenden Consumergruppe.

options

IotHubResourceGetEventHubConsumerGroupOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<EventHubConsumerGroupInfo>

getJob(string, string, string, IotHubResourceGetJobOptionalParams)

Rufen Sie die Details eines Auftrags von einem IoT-Hub ab. Weitere Informationen finden Sie unter: 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

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

jobId

string

Der Auftragsbezeichner.

options

IotHubResourceGetJobOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<JobResponse>

getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)

Rufen Sie eine freigegebene Zugriffsrichtlinie anhand des Namens von einem IoT-Hub ab. Weitere Informationen finden Sie unter: 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

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

keyName

string

Der Name der Richtlinie für den freigegebenen Zugriff.

options

IotHubResourceGetKeysForKeyNameOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<SharedAccessSignatureAuthorizationRule>

getStats(string, string, IotHubResourceGetStatsOptionalParams)

Rufen Sie die Statistiken von einem IoT-Hub ab.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

options

IotHubResourceGetStatsOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<RegistryStatistics>

importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)

Importieren, Aktualisieren oder Löschen von Geräteidentitäten in der IoT Hub-Identitätsregistrierung aus einem BLOB. Weitere Informationen finden Sie unter: 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

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

importDevicesParameters

ImportDevicesRequest

Die Parameter, die den Importgerätevorgang angeben.

options

IotHubResourceImportDevicesOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<JobResponse>

listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)

Rufen Sie alle IoT-Hubs in einer Ressourcengruppe ab.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

options

IotHubResourceListByResourceGroupOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>

listBySubscription(IotHubResourceListBySubscriptionOptionalParams)

Rufen Sie alle IoT-Hubs in einem Abonnement ab.

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

Parameter

options

IotHubResourceListBySubscriptionOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>

listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)

Rufen Sie die Integrität für Routingendpunkte ab.

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

Parameter

resourceGroupName

string

iotHubName

string

options

IotHubResourceGetEndpointHealthOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>

listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)

Rufen Sie eine Liste der Consumergruppen im Event Hub-kompatiblen Geräte-zu-Cloud-Endpunkt in einem IoT-Hub ab.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

eventHubEndpointName

string

Der Name des event Hub-kompatiblen Endpunkts.

options

IotHubResourceListEventHubConsumerGroupsOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>

listJobs(string, string, IotHubResourceListJobsOptionalParams)

Dient zum Abrufen einer Liste aller Aufträge in einem IoT-Hub. Weitere Informationen finden Sie unter: 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

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

options

IotHubResourceListJobsOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>

listKeys(string, string, IotHubResourceListKeysOptionalParams)

Rufen Sie die Sicherheitsmetadaten für einen IoT-Hub ab. Weitere Informationen finden Sie unter: 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

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

options

IotHubResourceListKeysOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>

listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)

Rufen Sie die Kontingentmetriken für einen IoT-Hub ab.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

options

IotHubResourceGetQuotaMetricsOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>

listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)

Ruft die Liste der gültigen SKUs für einen IoT-Hub ab.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den IoT-Hub enthält.

resourceName

string

Der Name des IoT-Hubs.

options

IotHubResourceGetValidSkusOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>

testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)

Testen aller Routen, die in diesem Iot Hub konfiguriert sind

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

Parameter

iotHubName

string

Zu testende IotHub

resourceGroupName

string

Ressourcengruppe, zu der Iot Hub gehört

input

TestAllRoutesInput

Eingabe zum Testen aller Routen

options

IotHubResourceTestAllRoutesOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TestAllRoutesResult>

testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)

Testen der neuen Route für diesen Iot Hub

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

Parameter

iotHubName

string

Zu testende IotHub

resourceGroupName

string

Ressourcengruppe, zu der Iot Hub gehört

input

TestRouteInput

Route, die getestet werden muss

options

IotHubResourceTestRouteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<TestRouteResult>