Freigeben über

IotHubResourceOperations Klasse

  • Referenz

Warnung

Instanziieren Sie diese Klasse NICHT direkt.

Stattdessen sollten Sie auf die folgenden Vorgänge zugreifen:

IotHubClient's

<xref:iot_hub_resource> -Attribut.

Vererbung
builtins.object
IotHubResourceOperations

Konstruktor

IotHubResourceOperations(*args, **kwargs)

Methoden

begin_create_or_update

Erstellen oder aktualisieren Sie die Metadaten eines IoT Hubs.

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

Löschen sie einen IoT Hub.

Löschen sie einen IoT Hub.
begin_update

Aktualisieren sie vorhandene IoT Hubs-Tags.

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

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

Überprüfen Sie, ob ein IoT Hub-Name verfügbar ist.
create_event_hub_consumer_group

Fügen Sie eine Consumergruppe zu einem Event Hub-kompatiblen Endpunkt in einem IoT Hub hinzu.

Fügen Sie eine Consumergruppe zu einem Event Hub-kompatiblen Endpunkt in einem IoT Hub hinzu.
delete_event_hub_consumer_group

Löschen Sie eine Consumergruppe aus einem Event Hub-kompatiblen Endpunkt in einem IoT Hub.

Löschen Sie eine Consumergruppe aus einem Event Hub-kompatiblen Endpunkt in einem IoT Hub.
export_devices

Exportiert alle Geräteidentitäten in der IoT Hub-Identitätsregistrierung in einen Azure Storage-Blobcontainer. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Exportiert alle Geräteidentitäten in der IoT Hub-Identitätsregistrierung in einen Azure Storage-Blobcontainer. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
get

Rufen Sie die nicht sicherheitsrelevanten Metadaten eines IoT Hubs ab.

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

Rufen Sie die Integrität für das Routing von Endpunkten ab.

Rufen Sie die Integrität für das Routing von Endpunkten ab.
get_event_hub_consumer_group

Rufen Sie eine Consumergruppe vom Event Hub-kompatiblen Device-to-Cloud-Endpunkt für einen IoT Hub ab.

Rufen Sie eine Consumergruppe vom Event Hub-kompatiblen Device-to-Cloud-Endpunkt für einen IoT Hub ab.
get_job

Rufen Sie die Details eines Auftrags aus einem IoT Hub ab. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Rufen Sie die Details eines Auftrags aus einem IoT Hub ab. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
get_keys_for_key_name

Rufen Sie eine Richtlinie für freigegebenen Zugriff anhand des Namens von einem IoT Hub ab. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Rufen Sie eine Richtlinie für freigegebenen Zugriff anhand des Namens von einem IoT Hub ab. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
get_quota_metrics

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

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

Rufen Sie die Statistiken von einem IoT Hub ab.

Rufen Sie die Statistiken von einem IoT Hub ab.
get_valid_skus

Rufen Sie die Liste der gültigen SKUs für einen IoT Hub ab.

Rufen Sie die Liste der gültigen SKUs für einen IoT Hub ab.
import_devices

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.

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.
list_by_resource_group

Rufen Sie alle IoT Hubs in einer Ressourcengruppe ab.

Rufen Sie alle IoT Hubs in einer Ressourcengruppe ab.
list_by_subscription

Rufen Sie alle IoT Hubs in einem Abonnement ab.

Rufen Sie alle IoT Hubs in einem Abonnement ab.
list_event_hub_consumer_groups

Rufen Sie eine Liste der Consumergruppen im Event Hub-kompatiblen Device-to-Cloud-Endpunkt in einem IoT Hub ab.

Rufen Sie eine Liste der Consumergruppen im Event Hub-kompatiblen Device-to-Cloud-Endpunkt in einem IoT Hub ab.
list_jobs

Rufen Sie eine Liste aller Aufträge in einem IoT Hub ab. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Rufen Sie eine Liste aller Aufträge in einem IoT Hub ab. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
list_keys

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.

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.
test_all_routes

Testen Sie alle Routen.

Testen Sie alle Routen, die in diesem Iot Hub konfiguriert sind.
test_route

Testen Sie die neue Route.

Testen Sie die neue Route für diesen Iot Hub.

begin_create_or_update

Erstellen oder aktualisieren Sie die Metadaten eines IoT Hubs.

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

begin_create_or_update(resource_group_name: str, resource_name: str, iot_hub_description: _models.IotHubDescription, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.IotHubDescription]

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

iot_hub_description
IotHubDescription oder IO
Erforderlich

Die IoT Hub-Metadaten und Sicherheitsmetadaten. Ist entweder ein IotHubDescription-Typ oder ein E/A-Typ. Erforderlich.

if_match
str
Erforderlich

ETag des IoT Hub. Geben Sie zum Erstellen eines brandneuen IoT Hub nicht an. Erforderlich, um eine vorhandene IoT Hub zu aktualisieren. Der Standardwert ist Keine.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind: "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

continuation_token
str

Ein Fortsetzungstoken zum Neustarten eines Abrufs aus einem gespeicherten Zustand.

polling
bool oder PollingMethod

Standardmäßig lautet die Abrufmethode ARMPolling. Übergeben Sie False, damit dieser Vorgang nicht abruft, oder übergeben Sie Ihr eigenes initialisiertes Abrufobjekt für eine persönliche Abrufstrategie.

polling_interval
int

Standardwartezeit zwischen zwei Abrufen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist.

Gibt zurück

Eine instance von LROPoller, die entweder IotHubDescription oder das Ergebnis von cls(response) zurückgibt.

Rückgabetyp

LROPoller[IotHubDescription]

Ausnahmen

HttpResponseError

begin_delete

Löschen sie einen IoT Hub.

Löschen sie einen IoT Hub.

begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> LROPoller[IotHubDescription]

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

continuation_token
str

Ein Fortsetzungstoken zum Neustarten eines Abrufs aus einem gespeicherten Zustand.

polling
bool oder PollingMethod

Standardmäßig lautet die Abrufmethode ARMPolling. Übergeben Sie False, damit dieser Vorgang nicht abruft, oder übergeben Sie Ihr eigenes initialisiertes Abrufobjekt für eine persönliche Abrufstrategie.

polling_interval
int

Standardwartezeit zwischen zwei Abrufen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist.

Gibt zurück

Eine instance von LROPoller, die entweder IotHubDescription oder Eine instance von LROPoller zurückgibt, die entweder ErrorDetails oder das Ergebnis von cls(response) zurückgibt.

Rückgabetyp

LROPoller[IotHubDescription],
LROPoller[ErrorDetails]

Ausnahmen

HttpResponseError

begin_update

Aktualisieren sie vorhandene IoT Hubs-Tags.

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

begin_update(resource_group_name: str, resource_name: str, iot_hub_tags: _models.TagsResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.IotHubDescription]

Parameter

resource_group_name
str
Erforderlich

Ressourcengruppenbezeichner. Erforderlich.

resource_name
str
Erforderlich

Name des zu aktualisierenden Iot Hubs. Erforderlich.

iot_hub_tags
TagsResource oder IO
Erforderlich

Die Taginformationen wurden aktualisiert, um sie im iot Hub-instance festzulegen. Ist entweder ein TagsResource-Typ oder ein E/A-Typ. Erforderlich.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind: "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

continuation_token
str

Ein Fortsetzungstoken zum Neustarten eines Abrufs aus einem gespeicherten Zustand.

polling
bool oder PollingMethod

Standardmäßig lautet die Abrufmethode ARMPolling. Übergeben Sie False, damit dieser Vorgang nicht abruft, oder übergeben Sie Ihr eigenes initialisiertes Abrufobjekt für eine persönliche Abrufstrategie.

polling_interval
int

Standardwartezeit zwischen zwei Abrufen für LRO-Vorgänge, wenn kein Retry-After-Header vorhanden ist.

Gibt zurück

Eine instance von LROPoller, die entweder IotHubDescription oder das Ergebnis von cls(response) zurückgibt.

Rückgabetyp

LROPoller[IotHubDescription]

Ausnahmen

HttpResponseError

check_name_availability

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

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

check_name_availability(operation_inputs: _models.OperationInputs, *, content_type: str = 'application/json', **kwargs: Any) -> _models.IotHubNameAvailabilityInfo

Parameter

operation_inputs
OperationInputs oder IO
Erforderlich

Legen Sie den name-Parameter in der OperationInputs-Struktur auf den Namen des zu überprüfenden IoT-Hubs fest. Ist entweder ein OperationInputs-Typ oder ein E/A-Typ. Erforderlich.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind: "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

IotHubNameAvailabilityInfo oder das Ergebnis von cls(response)

Rückgabetyp

IotHubNameAvailabilityInfo

Ausnahmen

HttpResponseError

create_event_hub_consumer_group

Fügen Sie eine Consumergruppe zu einem Event Hub-kompatiblen Endpunkt in einem IoT Hub hinzu.

Fügen Sie eine Consumergruppe zu einem Event Hub-kompatiblen Endpunkt in einem IoT Hub hinzu.

create_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, consumer_group_body: _models.EventHubConsumerGroupBodyDescription, *, content_type: str = 'application/json', **kwargs: Any) -> _models.EventHubConsumerGroupInfo

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

event_hub_endpoint_name
str
Erforderlich

Der Name des Event Hub-kompatiblen Endpunkts im IoT Hub. Erforderlich.

name
str
Erforderlich

Der Name der hinzuzufügenden Consumergruppe. Erforderlich.

consumer_group_body
EventHubConsumerGroupBodyDescription oder IO
Erforderlich

Die hinzuzufügende Consumergruppe. Ist entweder ein EventHubConsumerGroupBodyDescription-Typ oder ein E/A-Typ. Erforderlich.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind: "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

EventHubConsumerGroupInfo oder das Ergebnis von cls(response)

Rückgabetyp

EventHubConsumerGroupInfo

Ausnahmen

HttpResponseError

delete_event_hub_consumer_group

Löschen Sie eine Consumergruppe aus einem Event Hub-kompatiblen Endpunkt in einem IoT Hub.

Löschen Sie eine Consumergruppe aus einem Event Hub-kompatiblen Endpunkt in einem IoT Hub.

delete_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> None

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

event_hub_endpoint_name
str
Erforderlich

Der Name des Event Hub-kompatiblen Endpunkts im IoT Hub. Erforderlich.

name
str
Erforderlich

Der Name der zu löschenden Consumergruppe. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Keine oder das Ergebnis von cls(response)

Rückgabetyp

None

Ausnahmen

HttpResponseError

export_devices

Exportiert alle Geräteidentitäten in der IoT Hub-Identitätsregistrierung in einen Azure Storage-Blobcontainer. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Exportiert alle Geräteidentitäten in der IoT Hub-Identitätsregistrierung in einen Azure Storage-Blobcontainer. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

export_devices(resource_group_name: str, resource_name: str, export_devices_parameters: _models.ExportDevicesRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.JobResponse

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

export_devices_parameters
ExportDevicesRequest oder IO
Erforderlich

Die Parameter, die den Vorgang zum Exportieren von Geräten angeben. Ist entweder ein ExportDevicesRequest-Typ oder ein E/A-Typ. Erforderlich.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind : "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

JobResponse oder das Ergebnis von cls(response)

Rückgabetyp

JobResponse

Ausnahmen

HttpResponseError

get

Rufen Sie die nicht sicherheitsrelevanten Metadaten eines IoT Hubs ab.

Rufen Sie die nicht sicherheitsrelevanten Metadaten eines IoT Hubs ab.

get(resource_group_name: str, resource_name: str, **kwargs: Any) -> IotHubDescription

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

IotHubDescription oder das Ergebnis von cls(response)

Rückgabetyp

IotHubDescription

Ausnahmen

HttpResponseError

get_endpoint_health

Rufen Sie die Integrität für das Routing von Endpunkten ab.

Rufen Sie die Integrität für das Routing von Endpunkten ab.

get_endpoint_health(resource_group_name: str, iot_hub_name: str, **kwargs: Any) -> Iterable[EndpointHealthData]

Parameter

resource_group_name
str
Erforderlich

Erforderlich.

iot_hub_name
str
Erforderlich

Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Ein Iterator wie instance von EndpointHealthData oder das Ergebnis von cls(response)

Rückgabetyp

ItemPaged[EndpointHealthData]

Ausnahmen

HttpResponseError

get_event_hub_consumer_group

Rufen Sie eine Consumergruppe vom Event Hub-kompatiblen Device-to-Cloud-Endpunkt für einen IoT Hub ab.

Rufen Sie eine Consumergruppe vom Event Hub-kompatiblen Device-to-Cloud-Endpunkt für einen IoT Hub ab.

get_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> EventHubConsumerGroupInfo

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

event_hub_endpoint_name
str
Erforderlich

Der Name des Event Hub-kompatiblen Endpunkts im IoT Hub. Erforderlich.

name
str
Erforderlich

Der Name der abzurufenden Consumergruppe. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

EventHubConsumerGroupInfo oder das Ergebnis von cls(response)

Rückgabetyp

EventHubConsumerGroupInfo

Ausnahmen

HttpResponseError

get_job

Rufen Sie die Details eines Auftrags aus einem IoT Hub ab. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Rufen Sie die Details eines Auftrags aus einem IoT Hub ab. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

get_job(resource_group_name: str, resource_name: str, job_id: str, **kwargs: Any) -> JobResponse

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

job_id
str
Erforderlich

Der Auftragsbezeichner. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

JobResponse oder das Ergebnis von cls(response)

Rückgabetyp

JobResponse

Ausnahmen

HttpResponseError

get_keys_for_key_name

Rufen Sie eine Richtlinie für freigegebenen Zugriff anhand des Namens von einem IoT Hub ab. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Rufen Sie eine Richtlinie für freigegebenen Zugriff anhand des Namens von einem IoT Hub ab. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

get_keys_for_key_name(resource_group_name: str, resource_name: str, key_name: str, **kwargs: Any) -> SharedAccessSignatureAuthorizationRule

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

key_name
str
Erforderlich

Der Name der SAS-Richtlinie. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

SharedAccessSignatureAuthorizationRule oder das Ergebnis von cls(response)

Rückgabetyp

SharedAccessSignatureAuthorizationRule

Ausnahmen

HttpResponseError

get_quota_metrics

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

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

get_quota_metrics(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[IotHubQuotaMetricInfo]

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Ein Iterator wie instance von IotHubQuotaMetricInfo oder das Ergebnis von cls(response)

Rückgabetyp

ItemPaged[IotHubQuotaMetricInfo]

Ausnahmen

HttpResponseError

get_stats

Rufen Sie die Statistiken von einem IoT Hub ab.

Rufen Sie die Statistiken von einem IoT Hub ab.

get_stats(resource_group_name: str, resource_name: str, **kwargs: Any) -> RegistryStatistics

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

RegistryStatistics oder das Ergebnis von cls(response)

Rückgabetyp

RegistryStatistics

Ausnahmen

HttpResponseError

get_valid_skus

Rufen Sie die Liste der gültigen SKUs für einen IoT Hub ab.

Rufen Sie die Liste der gültigen SKUs für einen IoT Hub ab.

get_valid_skus(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[IotHubSkuDescription]

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Ein Iterator wie instance von IotHubSkuDescription oder das Ergebnis von cls(response)

Rückgabetyp

ItemPaged[IotHubSkuDescription]

Ausnahmen

HttpResponseError

import_devices

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.

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.

import_devices(resource_group_name: str, resource_name: str, import_devices_parameters: _models.ImportDevicesRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.JobResponse

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

import_devices_parameters
ImportDevicesRequest oder IO
Erforderlich

Die Parameter, die den Importgerätevorgang angeben. Ist entweder ein ImportDevicesRequest-Typ oder ein E/A-Typ. Erforderlich.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind : "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

JobResponse oder das Ergebnis von cls(response)

Rückgabetyp

JobResponse

Ausnahmen

HttpResponseError

list_by_resource_group

Rufen Sie alle IoT Hubs in einer Ressourcengruppe ab.

Rufen Sie alle IoT Hubs in einer Ressourcengruppe ab.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[IotHubDescription]

Parameter

resource_group_name
str
Erforderlich

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

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Ein Iterator wie instance von IotHubDescription oder das Ergebnis von cls(response)

Rückgabetyp

ItemPaged[IotHubDescription]

Ausnahmen

HttpResponseError

list_by_subscription

Rufen Sie alle IoT Hubs in einem Abonnement ab.

Rufen Sie alle IoT Hubs in einem Abonnement ab.

list_by_subscription(**kwargs: Any) -> Iterable[IotHubDescription]

Parameter

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Ein Iterator wie instance von IotHubDescription oder das Ergebnis von cls(response)

Rückgabetyp

ItemPaged[IotHubDescription]

Ausnahmen

HttpResponseError

list_event_hub_consumer_groups

Rufen Sie eine Liste der Consumergruppen im Event Hub-kompatiblen Device-to-Cloud-Endpunkt in einem IoT Hub ab.

Rufen Sie eine Liste der Consumergruppen im Event Hub-kompatiblen Device-to-Cloud-Endpunkt in einem IoT Hub ab.

list_event_hub_consumer_groups(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, **kwargs: Any) -> Iterable[EventHubConsumerGroupInfo]

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

event_hub_endpoint_name
str
Erforderlich

Der Name des Event Hub-kompatiblen Endpunkts. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Ein Iterator wie instance von EventHubConsumerGroupInfo oder das Ergebnis von cls(response)

Rückgabetyp

ItemPaged[EventHubConsumerGroupInfo]

Ausnahmen

HttpResponseError

list_jobs

Rufen Sie eine Liste aller Aufträge in einem IoT Hub ab. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Rufen Sie eine Liste aller Aufträge in einem IoT Hub ab. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

list_jobs(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[JobResponse]

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Ein Iterator wie instance von JobResponse oder das Ergebnis von cls(response)

Rückgabetyp

ItemPaged[JobResponse]

Ausnahmen

HttpResponseError

list_keys

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.

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.

list_keys(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[SharedAccessSignatureAuthorizationRule]

Parameter

resource_group_name
str
Erforderlich

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

resource_name
str
Erforderlich

Der Name des IoT-Hubs. Erforderlich.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

Ein Iterator wie instance von SharedAccessSignatureAuthorizationRule oder das Ergebnis von cls(response)

Rückgabetyp

ItemPaged[SharedAccessSignatureAuthorizationRule]

Ausnahmen

HttpResponseError

test_all_routes

Testen Sie alle Routen.

Testen Sie alle Routen, die in diesem Iot Hub konfiguriert sind.

test_all_routes(iot_hub_name: str, resource_group_name: str, input: _models.TestAllRoutesInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestAllRoutesResult

Parameter

iot_hub_name
str
Erforderlich

IotHub soll getestet werden. Erforderlich.

resource_group_name
str
Erforderlich

Ressourcengruppe, zu der Iot Hub gehört. Erforderlich.

input
TestAllRoutesInput oder IO
Erforderlich

Eingabe zum Testen aller Routen. Ist entweder ein TestAllRoutesInput-Typ oder ein E/A-Typ. Erforderlich.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind : "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

TestAllRoutesResult oder das Ergebnis von cls(response)

Rückgabetyp

TestAllRoutesResult

Ausnahmen

HttpResponseError

test_route

Testen Sie die neue Route.

Testen Sie die neue Route für diesen Iot Hub.

test_route(iot_hub_name: str, resource_group_name: str, input: _models.TestRouteInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestRouteResult

Parameter

iot_hub_name
str
Erforderlich

IotHub soll getestet werden. Erforderlich.

resource_group_name
str
Erforderlich

Ressourcengruppe, zu der Iot Hub gehört. Erforderlich.

input
TestRouteInput oder IO
Erforderlich

Route, die getestet werden muss. Ist entweder ein TestRouteInput-Typ oder ein E/A-Typ. Erforderlich.

content_type
str

Textparameter-Inhaltstyp. Bekannte Werte sind : "application/json". Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

TestRouteResult oder das Ergebnis von cls(response)

Rückgabetyp

TestRouteResult

Ausnahmen

HttpResponseError

Attribute

models 

models = <module 'azure.mgmt.iothub.v2023_06_30.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\iothub\\v2023_06_30\\models\\__init__.py'>