Partager via


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é IoT Hub, 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 de IoT Hub peut entraîner le retour par défaut de ces valeurs, ce qui peut entraîner un comportement inattendu.

begin_delete

Supprimez un hub IoT.

Supprimez un hub IoT.

check_name_availability

Vérifiez si un nom IoT Hub est disponible.

Vérifiez si un nom IoT Hub est disponible.

create_event_hub_consumer_group

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

Ajoutez un groupe de consommateurs à un point de terminaison compatible Avec 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 d’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 d’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_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 d’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 d’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.

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é IoT Hub, 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 de IoT Hub peut entraîner le retour par défaut de ces valeurs, ce qui peut entraîner un comportement inattendu.

async 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) -> AsyncLROPoller[_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 de sécurité du hub IoT. Est un type IotHubDescription ou un type d’E/S. Obligatoire.

if_match
str
Obligatoire

ETag du IoT Hub. Ne spécifiez pas pour la création d’un nouveau IoT Hub. Obligatoire 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 AsyncPollingMethod

Par défaut, votre méthode d’interrogation est AsyncARMPolling. Passez la valeur False pour que cette opération n’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 d’AsyncLROPoller qui retourne IotHubDescription ou le résultat de cls(response)

Type de retour

Exceptions

begin_delete

Supprimez un hub IoT.

Supprimez un hub IoT.

async begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> AsyncLROPoller[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 AsyncPollingMethod

Par défaut, votre méthode d’interrogation est AsyncARMPolling. Passez la valeur False pour que cette opération n’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 d’AsyncLROPoller qui retourne IotHubDescription ou Un instance d’AsyncLROPoller qui retourne ErrorDetails ou le résultat de cls(response)

Type de retour

Exceptions

check_name_availability

Vérifiez si un nom IoT Hub est disponible.

Vérifiez si un nom IoT Hub est disponible.

async 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 pour case activée. Est un type OperationInputs 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

IotHubNameAvailabilityInfo ou le résultat de cls(response)

Type de retour

Exceptions

create_event_hub_consumer_group

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

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

async 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 Avec 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

Exceptions

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.

async 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 Avec 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

Exceptions

export_devices

Exporte toutes les identités d’appareil dans le registre d’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 d’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.

async 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 d’appareils. Est un type ExportDevicesRequest 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

JobResponse ou le résultat de cls(response)

Type de retour

Exceptions

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.

async 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

Exceptions

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.

async 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

Exceptions

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.

async 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

Exceptions

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.

async 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

Exceptions

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) -> AsyncIterable[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

Exceptions

get_stats

Obtenez les statistiques d’un hub IoT.

Obtenez les statistiques d’un hub IoT.

async 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

Exceptions

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) -> AsyncIterable[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

Exceptions

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.

async 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

Exceptions

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) -> AsyncIterable[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

Exceptions

list_by_subscription

Obtenez tous les hubs IoT d’un abonnement.

Obtenez tous les hubs IoT d’un abonnement.

list_by_subscription(**kwargs: Any) -> AsyncIterable[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

Exceptions

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) -> AsyncIterable[str]

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

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

Type de retour

Exceptions

list_jobs

Obtenez la liste de tous les travaux d’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 d’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) -> AsyncIterable[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 le résultat de cls(response)

Type de retour

Exceptions

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) -> AsyncIterable[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

Exceptions

Attributs

models

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