Condividi tramite


IotHubResourceOperations Classe

Avviso

NON creare direttamente un'istanza di questa classe.

È invece necessario accedere alle operazioni seguenti tramite

IotHubClient's

Attributo<xref:iot_hub_resource> .

Ereditarietà
builtins.object
IotHubResourceOperations

Costruttore

IotHubResourceOperations(*args, **kwargs)

Metodi

begin_create_or_update

Creare o aggiornare i metadati di un hub IoT.

Creare o aggiornare i metadati di un hub Iot. Il modello consueto per modificare una proprietà consiste nel recuperare i metadati e i metadati di sicurezza dell'hub IoT e quindi combinarli con i valori modificati in un nuovo corpo per aggiornare l'hub IoT. Se alcune proprietà non sono presenti nel codice JSON, l'aggiornamento di hub IoT può causare il fallback di questi valori all'impostazione predefinita, causando un comportamento imprevisto.

begin_delete

Eliminare un hub IoT.

Eliminare un hub IoT.

check_name_availability

Controllare se è disponibile un nome dell'hub IoT.

Controllare se è disponibile un nome dell'hub IoT.

create_event_hub_consumer_group

Aggiungere un gruppo di consumer a un endpoint compatibile con l'hub eventi in un hub IoT.

Aggiungere un gruppo di consumer a un endpoint compatibile con l'hub eventi in un hub IoT.

delete_event_hub_consumer_group

Eliminare un gruppo di consumer da un endpoint compatibile con l'hub eventi in un hub IoT.

Eliminare un gruppo di consumer da un endpoint compatibile con l'hub eventi in un hub IoT.

export_devices

Esporta tutte le identità del dispositivo nel registro delle identità dell'hub IoT in un contenitore BLOB di Archiviazione di Azure. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Esporta tutte le identità del dispositivo nel registro delle identità dell'hub IoT in un contenitore BLOB di Archiviazione di Azure. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

get

Ottenere i metadati non correlati alla sicurezza di un hub IoT.

Ottenere i metadati non correlati alla sicurezza di un hub IoT.

get_event_hub_consumer_group

Ottenere un gruppo di consumer dall'endpoint da dispositivo a cloud compatibile con hub eventi per un hub IoT.

Ottenere un gruppo di consumer dall'endpoint da dispositivo a cloud compatibile con hub eventi per un hub IoT.

get_job

Ottenere i dettagli di un processo da un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Ottenere i dettagli di un processo da un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

get_keys_for_key_name

Ottenere un criterio di accesso condiviso per nome da un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Ottenere un criterio di accesso condiviso per nome da un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

get_quota_metrics

Ottenere le metriche di quota per un hub IoT.

Ottenere le metriche di quota per un hub IoT.

get_stats

Ottenere le statistiche da un hub IoT.

Ottenere le statistiche da un hub IoT.

get_valid_skus

Ottenere l'elenco di SKU validi per un hub IoT.

Ottenere l'elenco di SKU validi per un hub IoT.

import_devices

Importare, aggiornare o eliminare le identità del dispositivo nel Registro identità dell'hub IoT da un BLOB. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Importare, aggiornare o eliminare le identità del dispositivo nel Registro identità dell'hub IoT da un BLOB. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

list_by_resource_group

Ottenere tutti gli hub IoT in un gruppo di risorse.

Ottenere tutti gli hub IoT in un gruppo di risorse.

list_by_subscription

Ottenere tutti gli hub IoT in una sottoscrizione.

Ottenere tutti gli hub IoT in una sottoscrizione.

list_event_hub_consumer_groups

Ottenere un elenco dei gruppi di consumer nell'endpoint da dispositivo a cloud compatibile con hub eventi in un hub IoT.

Ottenere un elenco dei gruppi di consumer nell'endpoint da dispositivo a cloud compatibile con Hub eventi in un hub IoT.

list_jobs

Ottenere un elenco di tutti i processi in un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Ottenere un elenco di tutti i processi in un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

list_keys

Ottenere i metadati di sicurezza per un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Ottenere i metadati di sicurezza per un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

begin_create_or_update

Creare o aggiornare i metadati di un hub IoT.

Creare o aggiornare i metadati di un hub Iot. Il modello consueto per modificare una proprietà consiste nel recuperare i metadati e i metadati di sicurezza dell'hub IoT e quindi combinarli con i valori modificati in un nuovo corpo per aggiornare l'hub IoT. Se alcune proprietà non sono presenti nel codice JSON, l'aggiornamento di hub IoT può causare il fallback di questi valori all'impostazione predefinita, causando un comportamento imprevisto.

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]

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse che contiene l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

iot_hub_description
IotHubDescription oppure IO
Necessario

Metadati dell'hub IoT e metadati di sicurezza. È un tipo IotHubDescription o un tipo di I/O. Obbligatorio.

if_match
str
Necessario

ETag del hub IoT. Non specificare per la creazione di un nuovo hub IoT. Necessario per aggiornare un hub IoT esistente. Il valore predefinito è Nessuno.

content_type
str

Content-type del parametro del corpo. I valori noti sono: 'application/json'. Il valore predefinito è Nessuno.

cls
callable

Tipo o funzione personalizzata che verrà passata alla risposta diretta

continuation_token
str

Token di continuazione per riavviare un poller da uno stato salvato.

polling
bool oppure PollingMethod

Per impostazione predefinita, il metodo di polling sarà ARMPolling. Passare False per questa operazione per non eseguire il polling o passare il proprio oggetto di polling inizializzato per una strategia di polling personale.

polling_interval
int

Tempo di attesa predefinito tra due sondaggi per le operazioni LRO se non è presente alcuna intestazione Retry-After.

Restituisce

Istanza di LROPoller che restituisce IotHubDescription o il risultato di cls(response)

Tipo restituito

Eccezioni

begin_delete

Eliminare un hub IoT.

Eliminare un hub IoT.

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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse che contiene l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata alla risposta diretta

continuation_token
str

Token di continuazione per riavviare un poller da uno stato salvato.

polling
bool oppure PollingMethod

Per impostazione predefinita, il metodo di polling sarà ARMPolling. Passare False per questa operazione per non eseguire il polling o passare il proprio oggetto di polling inizializzato per una strategia di polling personale.

polling_interval
int

Tempo di attesa predefinito tra due sondaggi per le operazioni LRO se non è presente alcuna intestazione Retry-After.

Restituisce

Istanza di LROPoller che restituisce IotHubDescription o Un'istanza di LROPoller che restituisce ErrorDetails o il risultato di cls(response)

Tipo restituito

Eccezioni

check_name_availability

Controllare se è disponibile un nome dell'hub IoT.

Controllare se è disponibile un nome dell'hub IoT.

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

Parametri

operation_inputs
OperationInputs oppure IO
Necessario

Impostare il parametro name nella struttura OperationInputs sul nome dell'hub IoT da controllare. Tipo OperationInputs o I/O. Obbligatorio.

content_type
str

Content-type del parametro del corpo. I valori noti sono: 'application/json'. Il valore predefinito è Nessuno.

cls
callable

Tipo o funzione personalizzata che verrà passata alla risposta diretta

Restituisce

IotHubNameAvailabilityInfo o il risultato di cls(response)

Tipo restituito

Eccezioni

create_event_hub_consumer_group

Aggiungere un gruppo di consumer a un endpoint compatibile con l'hub eventi in un hub IoT.

Aggiungere un gruppo di consumer a un endpoint compatibile con l'hub eventi in 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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse che contiene l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

event_hub_endpoint_name
str
Necessario

Nome dell'endpoint compatibile con l'hub eventi nell'hub IoT. Obbligatorio.

name
str
Necessario

Nome del gruppo di consumer da aggiungere. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata alla risposta diretta

Restituisce

EventHubConsumerGroupInfo o il risultato di cls(response)

Tipo restituito

Eccezioni

delete_event_hub_consumer_group

Eliminare un gruppo di consumer da un endpoint compatibile con l'hub eventi in un hub IoT.

Eliminare un gruppo di consumer da un endpoint compatibile con l'hub eventi in 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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse che contiene l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

event_hub_endpoint_name
str
Necessario

Nome dell'endpoint compatibile con l'hub eventi nell'hub IoT. Obbligatorio.

name
str
Necessario

Nome del gruppo di consumer da eliminare. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata alla risposta diretta

Restituisce

Nessuno o il risultato di cls(response)

Tipo restituito

Eccezioni

export_devices

Esporta tutte le identità del dispositivo nel registro delle identità dell'hub IoT in un contenitore BLOB di Archiviazione di Azure. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Esporta tutte le identità del dispositivo nel registro delle identità dell'hub IoT in un contenitore BLOB di Archiviazione di Azure. Per altre informazioni, vedere: 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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse che contiene l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

export_devices_parameters
ExportDevicesRequest oppure IO
Necessario

Parametri che specificano l'operazione di esportazione dei dispositivi. Tipo ExportDevicesRequest o I/O. Obbligatorio.

content_type
str

Content-type del parametro del corpo. I valori noti sono: 'application/json'. Il valore predefinito è Nessuno.

cls
callable

Tipo o funzione personalizzata che verrà passata alla risposta diretta

Restituisce

JobResponse o il risultato di cls(response)

Tipo restituito

Eccezioni

get

Ottenere i metadati non correlati alla sicurezza di un hub IoT.

Ottenere i metadati non correlati alla sicurezza di un hub IoT.

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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse che contiene l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata la risposta diretta

Restituisce

IotHubDescription o il risultato di cls(response)

Tipo restituito

Eccezioni

get_event_hub_consumer_group

Ottenere un gruppo di consumer dall'endpoint da dispositivo a cloud compatibile con hub eventi per un hub IoT.

Ottenere un gruppo di consumer dall'endpoint da dispositivo a cloud compatibile con hub eventi per 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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse contenente l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

event_hub_endpoint_name
str
Necessario

Nome dell'endpoint compatibile con l'hub eventi nell'hub IoT. Obbligatorio.

name
str
Necessario

Nome del gruppo consumer da recuperare. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata la risposta diretta

Restituisce

EventHubConsumerGroupInfo o il risultato di cls(response)

Tipo restituito

Eccezioni

get_job

Ottenere i dettagli di un processo da un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Ottenere i dettagli di un processo da un hub IoT. Per altre informazioni, vedere: 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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse contenente l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

job_id
str
Necessario

Identificatore di processo. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata la risposta diretta

Restituisce

JobResponse o il risultato di cls(response)

Tipo restituito

Eccezioni

get_keys_for_key_name

Ottenere un criterio di accesso condiviso per nome da un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Ottenere un criterio di accesso condiviso per nome da un hub IoT. Per altre informazioni, vedere: 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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse contenente l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

key_name
str
Necessario

Nome dei criteri di accesso condiviso. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata la risposta diretta

Restituisce

SharedAccessSignatureAuthorizationRule o il risultato di cls(response)

Tipo restituito

Eccezioni

get_quota_metrics

Ottenere le metriche di quota per un hub IoT.

Ottenere le metriche di quota per un hub IoT.

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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse contenente l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata la risposta diretta

Restituisce

Iteratore come l'istanza di IotHubQuotaMetricInfo o il risultato di cls(response)

Tipo restituito

Eccezioni

get_stats

Ottenere le statistiche da un hub IoT.

Ottenere le statistiche da un hub IoT.

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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse contenente l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata la risposta diretta

Restituisce

RegistryStatistics o il risultato di cls(response)

Tipo restituito

Eccezioni

get_valid_skus

Ottenere l'elenco di SKU validi per un hub IoT.

Ottenere l'elenco di SKU validi per un hub IoT.

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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse contenente l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata la risposta diretta

Restituisce

Iteratore come l'istanza di IotHubSkuDescription o il risultato di cls(response)

Tipo restituito

Eccezioni

import_devices

Importare, aggiornare o eliminare le identità del dispositivo nel Registro identità dell'hub IoT da un BLOB. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Importare, aggiornare o eliminare le identità del dispositivo nel Registro identità dell'hub IoT da un BLOB. Per altre informazioni, vedere: 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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse contenente l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

import_devices_parameters
ImportDevicesRequest oppure IO
Necessario

Parametri che specificano l'operazione di importazione dei dispositivi. È un tipo ImportDevicesRequest o un tipo I/O. Obbligatorio.

content_type
str

Tipo di contenuto del parametro corpo. I valori noti sono: 'application/json'. Il valore predefinito è Nessuno.

cls
callable

Tipo o funzione personalizzata che verrà passata la risposta diretta

Restituisce

JobResponse o il risultato di cls(response)

Tipo restituito

Eccezioni

list_by_resource_group

Ottenere tutti gli hub IoT in un gruppo di risorse.

Ottenere tutti gli hub IoT in un gruppo di risorse.

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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse contenente l'hub IoT. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata la risposta diretta

Restituisce

Iteratore come istanza di IotHubDescription o il risultato di cls(response)

Tipo restituito

Eccezioni

list_by_subscription

Ottenere tutti gli hub IoT in una sottoscrizione.

Ottenere tutti gli hub IoT in una sottoscrizione.

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

Parametri

cls
callable

Tipo o funzione personalizzata che verrà passata la risposta diretta

Restituisce

Iteratore come istanza di IotHubDescription o il risultato di cls(response)

Tipo restituito

Eccezioni

list_event_hub_consumer_groups

Ottenere un elenco dei gruppi di consumer nell'endpoint da dispositivo a cloud compatibile con hub eventi in un hub IoT.

Ottenere un elenco dei gruppi di consumer nell'endpoint da dispositivo a cloud compatibile con Hub eventi in un hub IoT.

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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse contenente l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

event_hub_endpoint_name
str
Necessario

Nome dell'endpoint compatibile con Hub eventi. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata la risposta diretta

Restituisce

Iteratore come l'istanza di str o il risultato di cls(response)

Tipo restituito

Eccezioni

list_jobs

Ottenere un elenco di tutti i processi in un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Ottenere un elenco di tutti i processi in un hub IoT. Per altre informazioni, vedere: 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]

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse che contiene l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata alla risposta diretta

Restituisce

Iteratore come l'istanza di JobResponse o il risultato di cls(response)

Tipo restituito

Eccezioni

list_keys

Ottenere i metadati di sicurezza per un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Ottenere i metadati di sicurezza per un hub IoT. Per altre informazioni, vedere: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

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

Parametri

resource_group_name
str
Necessario

Nome del gruppo di risorse che contiene l'hub IoT. Obbligatorio.

resource_name
str
Necessario

Nome dell'hub IoT. Obbligatorio.

cls
callable

Tipo o funzione personalizzata che verrà passata alla risposta diretta

Restituisce

Iteratore come l'istanza di SharedAccessSignatureAuthorizationRule o il risultato di cls(response)

Tipo restituito

Eccezioni

Attributi

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'>