IotHubResourceOperations Classe

Avertissement

NE PAS instancier cette classe directement.

Au lieu de cela, vous devez accéder aux opérations suivantes via

IotHubClientEst

attribut<xref:iot_hub_resource> ;

Héritage

builtins.object

IotHubResourceOperations

Constructeur

IotHubResourceOperations(*args, **kwargs)

Méthodes

begin_create_or_update	Créez ou mettez à jour les métadonnées d’un hub IoT. Créez ou mettez à jour les métadonnées d’un hub Iot. Le modèle habituel pour modifier une propriété consiste à récupérer les métadonnées et les métadonnées de sécurité du hub IoT, puis à les combiner avec les valeurs modifiées dans un nouveau corps pour mettre à jour le hub IoT. Si certaines propriétés sont manquantes dans le JSON, la mise à jour d’IoT Hub peut entraîner la restauration par défaut de ces valeurs, ce qui peut entraîner un comportement inattendu.
begin_delete	Supprimer un hub IoT. Supprimer un hub IoT.
begin_update	Mettre à jour des balises IoT Hubs existantes. Mettre à jour une étiquette de IoT Hub existante. pour mettre à jour d’autres champs, utilisez la méthode CreateOrUpdate.
check_name_availability	Vérifiez si un nom de hub IoT est disponible. Vérifiez si un nom de hub IoT est disponible.
create_event_hub_consumer_group	Ajoutez un groupe de consommateurs à un point de terminaison compatible Event Hub dans un hub IoT. Ajoutez un groupe de consommateurs à un point de terminaison compatible Event Hub dans un hub IoT.
delete_event_hub_consumer_group	Supprimez un groupe de consommateurs d’un point de terminaison compatible Avec Event Hub dans un hub IoT. Supprimez un groupe de consommateurs d’un point de terminaison compatible Avec Event Hub dans un hub IoT.
export_devices	Exporte toutes les identités d’appareil dans le registre des identités IoT Hub vers un conteneur d’objets blob stockage Azure. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Exporte toutes les identités d’appareil dans le registre des identités IoT Hub vers un conteneur d’objets blob stockage Azure. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
get	Obtenez les métadonnées non liées à la sécurité d’un hub IoT. Obtenez les métadonnées non liées à la sécurité d’un hub IoT.
get_endpoint_health	Obtenez l’intégrité des points de terminaison de routage. Obtenez l’intégrité des points de terminaison de routage.
get_event_hub_consumer_group	Obtenez un groupe de consommateurs à partir du point de terminaison appareil-à-cloud compatible Event Hub pour un hub IoT. Obtenez un groupe de consommateurs à partir du point de terminaison appareil-à-cloud compatible Event Hub pour un hub IoT.
get_job	Obtenez les détails d’un travail à partir d’un hub IoT. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Obtenez les détails d’un travail à partir d’un hub IoT. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
get_keys_for_key_name	Obtenez une stratégie d’accès partagé par nom à partir d’un hub IoT. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Obtenez une stratégie d’accès partagé par nom à partir d’un hub IoT. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
get_quota_metrics	Obtenez les métriques de quota pour un hub IoT. Obtenez les métriques de quota pour un hub IoT.
get_stats	Obtenez les statistiques d’un hub IoT. Obtenez les statistiques d’un hub IoT.
get_valid_skus	Obtenez la liste des références SKU valides pour un hub IoT. Obtenez la liste des références SKU valides pour un hub IoT.
import_devices	Importez, mettez à jour ou supprimez des identités d’appareil dans le registre des identités IoT Hub à partir d’un objet blob. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Importez, mettez à jour ou supprimez des identités d’appareil dans le registre des identités IoT Hub à partir d’un objet blob. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
list_by_resource_group	Obtenez tous les hubs IoT dans un groupe de ressources. Obtenez tous les hubs IoT dans un groupe de ressources.
list_by_subscription	Obtenez tous les hubs IoT d’un abonnement. Obtenez tous les hubs IoT d’un abonnement.
list_event_hub_consumer_groups	Obtenez la liste des groupes de consommateurs dans le point de terminaison appareil-à-cloud compatible Event Hub dans un hub IoT. Obtenez la liste des groupes de consommateurs dans le point de terminaison appareil-à-cloud compatible Event Hub dans un hub IoT.
list_jobs	Obtenez la liste de tous les travaux dans un hub IoT. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Obtenez la liste de tous les travaux dans un hub IoT. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
list_keys	Obtenez les métadonnées de sécurité d’un hub IoT. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Obtenez les métadonnées de sécurité d’un hub IoT. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
test_all_routes	Testez tous les itinéraires. Testez tous les itinéraires configurés dans ce hub IoT.
test_route	Testez la nouvelle route. Testez la nouvelle route pour ce hub IoT.

begin_create_or_update

Créez ou mettez à jour les métadonnées d’un hub IoT.

Créez ou mettez à jour les métadonnées d’un hub Iot. Le modèle habituel pour modifier une propriété consiste à récupérer les métadonnées et les métadonnées de sécurité du hub IoT, puis à les combiner avec les valeurs modifiées dans un nouveau corps pour mettre à jour le hub IoT. Si certaines propriétés sont manquantes dans le JSON, la mise à jour d’IoT Hub peut entraîner la restauration par défaut de ces valeurs, ce qui peut entraîner un comportement inattendu.

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]

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

iot_hub_description

IotHubDescription ou IO

Obligatoire

Métadonnées et métadonnées de sécurité IoT Hub. Type IotHubDescription ou type D’E/S. Obligatoire.

if_match

str

Obligatoire

ETag du IoT Hub. Ne spécifiez pas pour créer une nouvelle IoT Hub. Requis pour mettre à jour un IoT Hub existant. La valeur par défaut est Aucun.

content_type

str

Body Parameter content-type. Les valeurs connues sont : « application/json ». La valeur par défaut est Aucun.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

continuation_token

str

Jeton de continuation pour redémarrer un polleur à partir d’un état enregistré.

polling

bool ou PollingMethod

Par défaut, votre méthode d’interrogation est ARMPolling. Transmettez False pour que cette opération ne interroge pas, ou transmettez votre propre objet d’interrogation initialisé pour une stratégie d’interrogation personnelle.

polling_interval

int

Temps d’attente par défaut entre deux sondages pour les opérations LRO si aucun en-tête Retry-After n’est présent.

Retours

Instance de LROPoller qui retourne IotHubDescription ou le résultat de cls(response)

Type de retour

LROPoller[IotHubDescription]

Exceptions

HttpResponseError

begin_delete

Supprimer un hub IoT.

Supprimer un hub IoT.

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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

continuation_token

str

Jeton de continuation pour redémarrer un polleur à partir d’un état enregistré.

polling

bool ou PollingMethod

Par défaut, votre méthode d’interrogation est ARMPolling. Transmettez False pour que cette opération ne interroge pas, ou transmettez votre propre objet d’interrogation initialisé pour une stratégie d’interrogation personnelle.

polling_interval

int

Temps d’attente par défaut entre deux sondages pour les opérations LRO si aucun en-tête Retry-After n’est présent.

Retours

Instance de LROPoller qui retourne IotHubDescription ou Un instance de LROPoller qui retourne ErrorDetails ou le résultat de cls(response)

Type de retour

LROPoller[IotHubDescription],

LROPoller[ErrorDetails]

Exceptions

HttpResponseError

begin_update

Mettre à jour des balises IoT Hubs existantes.

Mettre à jour une étiquette de IoT Hub existante. pour mettre à jour d’autres champs, utilisez la méthode CreateOrUpdate.

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

Paramètres

resource_group_name

str

Obligatoire

Identificateur du groupe de ressources. Obligatoire.

resource_name

str

Obligatoire

Nom du hub iot à mettre à jour. Obligatoire.

iot_hub_tags

TagsResource ou IO

Obligatoire

Mise à jour des informations de balise à définir dans le instance du hub iot. Type TagsResource ou type D’E/S. Obligatoire.

content_type

str

Body Parameter content-type. Les valeurs connues sont : « application/json ». La valeur par défaut est Aucun.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

continuation_token

str

Jeton de continuation pour redémarrer un polleur à partir d’un état enregistré.

polling

bool ou PollingMethod

Par défaut, votre méthode d’interrogation est ARMPolling. Transmettez False pour que cette opération ne interroge pas, ou transmettez votre propre objet d’interrogation initialisé pour une stratégie d’interrogation personnelle.

polling_interval

int

Temps d’attente par défaut entre deux sondages pour les opérations LRO si aucun en-tête Retry-After n’est présent.

Retours

Instance de LROPoller qui retourne IotHubDescription ou le résultat de cls(response)

Type de retour

LROPoller[IotHubDescription]

Exceptions

HttpResponseError

check_name_availability

Vérifiez si un nom de hub IoT est disponible.

Vérifiez si un nom de hub IoT est disponible.

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

Paramètres

operation_inputs

OperationInputs ou IO

Obligatoire

Définissez le paramètre name dans la structure OperationInputs sur le nom du hub IoT à case activée. Type OperationInputs ou type E/S. Obligatoire.

content_type

str

Body Parameter content-type. Les valeurs connues sont : « application/json ». La valeur par défaut est Aucun.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

IotHubNameAvailabilityInfo ou le résultat de cls(response)

Type de retour

IotHubNameAvailabilityInfo

Exceptions

HttpResponseError

create_event_hub_consumer_group

Ajoutez un groupe de consommateurs à un point de terminaison compatible Event Hub dans un hub IoT.

Ajoutez un groupe de consommateurs à un point de terminaison compatible Event Hub dans un hub IoT.

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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

event_hub_endpoint_name

str

Obligatoire

Nom du point de terminaison compatible Event Hub dans le hub IoT. Obligatoire.

name

str

Obligatoire

Nom du groupe de consommateurs à ajouter. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

EventHubConsumerGroupInfo ou le résultat de cls(response)

Type de retour

EventHubConsumerGroupInfo

Exceptions

HttpResponseError

delete_event_hub_consumer_group

Supprimez un groupe de consommateurs d’un point de terminaison compatible Avec Event Hub dans un hub IoT.

Supprimez un groupe de consommateurs d’un point de terminaison compatible Avec Event Hub dans un hub IoT.

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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

event_hub_endpoint_name

str

Obligatoire

Nom du point de terminaison compatible Event Hub dans le hub IoT. Obligatoire.

name

str

Obligatoire

Nom du groupe de consommateurs à supprimer. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Aucun ou le résultat de cls(response)

Type de retour

None

Exceptions

HttpResponseError

export_devices

Exporte toutes les identités d’appareil dans le registre des identités IoT Hub vers un conteneur d’objets blob stockage Azure. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Exporte toutes les identités d’appareil dans le registre des identités IoT Hub vers un conteneur d’objets blob stockage Azure. Pour plus d’informations, consultez 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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

export_devices_parameters

ExportDevicesRequest ou IO

Obligatoire

Paramètres qui spécifient l’opération d’exportation des appareils. Type ExportDevicesRequest ou type D’E/S. Obligatoire.

content_type

str

Body Parameter content-type. Les valeurs connues sont : « application/json ». La valeur par défaut est Aucun.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

JobResponse ou le résultat de cls(response)

Type de retour

JobResponse

Exceptions

HttpResponseError

get

Obtenez les métadonnées non liées à la sécurité d’un hub IoT.

Obtenez les métadonnées non liées à la sécurité d’un hub IoT.

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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

IotHubDescription ou le résultat de cls(response)

Type de retour

IotHubDescription

Exceptions

HttpResponseError

get_endpoint_health

Obtenez l’intégrité des points de terminaison de routage.

Obtenez l’intégrité des points de terminaison de routage.

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

Paramètres

resource_group_name

str

Obligatoire

Obligatoire.

iot_hub_name

str

Obligatoire

Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Un itérateur comme instance de EndpointHealthData ou le résultat de cls(response)

Type de retour

ItemPaged[EndpointHealthData]

Exceptions

HttpResponseError

get_event_hub_consumer_group

Obtenez un groupe de consommateurs à partir du point de terminaison appareil-à-cloud compatible Event Hub pour un hub IoT.

Obtenez un groupe de consommateurs à partir du point de terminaison appareil-à-cloud compatible Event Hub pour un hub IoT.

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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

event_hub_endpoint_name

str

Obligatoire

Nom du point de terminaison compatible Event Hub dans le hub IoT. Obligatoire.

name

str

Obligatoire

Nom du groupe de consommateurs à récupérer. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

EventHubConsumerGroupInfo ou le résultat de cls(response)

Type de retour

EventHubConsumerGroupInfo

Exceptions

HttpResponseError

get_job

Obtenez les détails d’un travail à partir d’un hub IoT. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Obtenez les détails d’un travail à partir d’un hub IoT. Pour plus d’informations, consultez 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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

job_id

str

Obligatoire

Identificateur du travail. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

JobResponse ou le résultat de cls(response)

Type de retour

JobResponse

Exceptions

HttpResponseError

get_keys_for_key_name

Obtenez une stratégie d’accès partagé par nom à partir d’un hub IoT. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Obtenez une stratégie d’accès partagé par nom à partir d’un hub IoT. Pour plus d’informations, consultez 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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

key_name

str

Obligatoire

Nom de la stratégie d’accès partagé. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

SharedAccessSignatureAuthorizationRule ou le résultat de cls(response)

Type de retour

SharedAccessSignatureAuthorizationRule

Exceptions

HttpResponseError

get_quota_metrics

Obtenez les métriques de quota pour un hub IoT.

Obtenez les métriques de quota pour un hub IoT.

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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Itérateur comme instance de IotHubQuotaMetricInfo ou le résultat de cls(response)

Type de retour

ItemPaged[IotHubQuotaMetricInfo]

Exceptions

HttpResponseError

get_stats

Obtenez les statistiques d’un hub IoT.

Obtenez les statistiques d’un hub IoT.

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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

RegistryStatistics ou le résultat de cls(response)

Type de retour

RegistryStatistics

Exceptions

HttpResponseError

get_valid_skus

Obtenez la liste des références SKU valides pour un hub IoT.

Obtenez la liste des références SKU valides pour un hub IoT.

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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Un itérateur comme instance de IotHubSkuDescription ou du résultat de cls(response)

Type de retour

ItemPaged[IotHubSkuDescription]

Exceptions

HttpResponseError

import_devices

Importez, mettez à jour ou supprimez des identités d’appareil dans le registre des identités IoT Hub à partir d’un objet blob. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Importez, mettez à jour ou supprimez des identités d’appareil dans le registre des identités IoT Hub à partir d’un objet blob. Pour plus d’informations, consultez 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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

import_devices_parameters

ImportDevicesRequest ou IO

Obligatoire

Paramètres qui spécifient l’opération d’importation d’appareils. Type ImportDevicesRequest ou type D’E/S. Obligatoire.

content_type

str

Body Parameter content-type. Les valeurs connues sont : « application/json ». La valeur par défaut est Aucun.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

JobResponse ou le résultat de cls(response)

Type de retour

JobResponse

Exceptions

HttpResponseError

list_by_resource_group

Obtenez tous les hubs IoT dans un groupe de ressources.

Obtenez tous les hubs IoT dans un groupe de ressources.

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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Un itérateur comme instance de IotHubDescription ou du résultat de cls(response)

Type de retour

ItemPaged[IotHubDescription]

Exceptions

HttpResponseError

list_by_subscription

Obtenez tous les hubs IoT d’un abonnement.

Obtenez tous les hubs IoT d’un abonnement.

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

Paramètres

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Un itérateur comme instance de IotHubDescription ou du résultat de cls(response)

Type de retour

ItemPaged[IotHubDescription]

Exceptions

HttpResponseError

list_event_hub_consumer_groups

Obtenez la liste des groupes de consommateurs dans le point de terminaison appareil-à-cloud compatible Event Hub dans un hub IoT.

Obtenez la liste des groupes de consommateurs dans le point de terminaison appareil-à-cloud compatible Event Hub dans un hub IoT.

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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

event_hub_endpoint_name

str

Obligatoire

Nom du point de terminaison compatible avec Event Hub. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Un itérateur comme instance d’EventHubConsumerGroupInfo ou le résultat de cls(response)

Type de retour

ItemPaged[EventHubConsumerGroupInfo]

Exceptions

HttpResponseError

list_jobs

Obtenez la liste de tous les travaux dans un hub IoT. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Obtenez la liste de tous les travaux dans un hub IoT. Pour plus d’informations, consultez 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]

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Un itérateur comme instance de JobResponse ou du résultat de cls(response)

Type de retour

ItemPaged[JobResponse]

Exceptions

HttpResponseError

list_keys

Obtenez les métadonnées de sécurité d’un hub IoT. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Obtenez les métadonnées de sécurité d’un hub IoT. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

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

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le hub IoT. Obligatoire.

resource_name

str

Obligatoire

Nom du hub IoT. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Un itérateur comme instance de SharedAccessSignatureAuthorizationRule ou le résultat de cls(response)

Type de retour

ItemPaged[SharedAccessSignatureAuthorizationRule]

Exceptions

HttpResponseError

test_all_routes

Testez tous les itinéraires.

Testez tous les itinéraires configurés dans ce hub IoT.

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

Paramètres

iot_hub_name

str

Obligatoire

IotHub à tester. Obligatoire.

resource_group_name

str

Obligatoire

groupe de ressources auquel Iot Hub appartient. Obligatoire.

input

TestAllRoutesInput ou IO

Obligatoire

Entrée pour tester tous les itinéraires. Est un type TestAllRoutesInput ou un type d’E/S. Obligatoire.

content_type

str

Body Parameter content-type. Les valeurs connues sont : « application/json ». La valeur par défaut est Aucun.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

TestAllRoutesResult ou le résultat de cls(response)

Type de retour

TestAllRoutesResult

Exceptions

HttpResponseError

test_route

Testez la nouvelle route.

Testez la nouvelle route pour ce hub IoT.

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

Paramètres

iot_hub_name

str

Obligatoire

IotHub à tester. Obligatoire.

resource_group_name

str

Obligatoire

groupe de ressources auquel Iot Hub appartient. Obligatoire.

input

TestRouteInput ou IO

Obligatoire

Itinéraire qui doit être testé. Type TestRouteInput ou type D’E/S. Obligatoire.

content_type

str

Body Parameter content-type. Les valeurs connues sont : « application/json ». La valeur par défaut est Aucun.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

TestRouteResult ou le résultat de cls(response)

Type de retour

TestRouteResult

Exceptions

HttpResponseError

Attributs

models

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