Compartir a través de


IotHubResourceOperations Clase

Advertencia

NO cree instancias de esta clase directamente.

En su lugar, debe acceder a las siguientes operaciones a través de

IotHubClient's

Atributo<xref:iot_hub_resource> .

Herencia
builtins.object
IotHubResourceOperations

Constructor

IotHubResourceOperations(*args, **kwargs)

Métodos

begin_create_or_update

Cree o actualice los metadatos de un centro de IoT.

Cree o actualice los metadatos de un centro de IoT. El patrón habitual para modificar una propiedad es recuperar los metadatos de IoT Hub y los metadatos de seguridad y, después, combinarlos con los valores modificados en un nuevo cuerpo para actualizar el centro de IoT. Si faltan determinadas propiedades en json, la actualización de IoT Hub puede provocar que estos valores se realicen de forma predeterminada, lo que puede provocar un comportamiento inesperado.

begin_delete

Elimine un centro de IoT.

Elimine un centro de IoT.

check_name_availability

Compruebe si hay disponible un nombre de centro de IoT.

Compruebe si hay disponible un nombre de centro de IoT.

create_event_hub_consumer_group

Agregue un grupo de consumidores a un punto de conexión compatible con Event Hubs en un centro de IoT.

Agregue un grupo de consumidores a un punto de conexión compatible con Event Hubs en un centro de IoT.

delete_event_hub_consumer_group

Elimine un grupo de consumidores de un punto de conexión compatible con Event Hubs en un centro de IoT.

Elimine un grupo de consumidores de un punto de conexión compatible con Event Hubs en un centro de IoT.

export_devices

Exporta todas las identidades de dispositivo del registro de identidades de IoT Hub a un contenedor de blobs de Azure Storage. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Exporta todas las identidades de dispositivo del registro de identidades de IoT Hub a un contenedor de blobs de Azure Storage. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

get

Obtenga los metadatos no relacionados con la seguridad de un centro de IoT.

Obtenga los metadatos no relacionados con la seguridad de un centro de IoT.

get_event_hub_consumer_group

Obtenga un grupo de consumidores del punto de conexión de dispositivo a nube compatible con Event Hubs para un centro de IoT.

Obtenga un grupo de consumidores del punto de conexión de dispositivo a nube compatible con Event Hubs para un centro de IoT.

get_job

Obtenga los detalles de un trabajo de un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Obtenga los detalles de un trabajo de un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

get_keys_for_key_name

Obtenga una directiva de acceso compartido por su nombre desde un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Obtenga una directiva de acceso compartido por su nombre desde un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

get_quota_metrics

Obtenga las métricas de cuota de un centro de IoT.

Obtenga las métricas de cuota de un centro de IoT.

get_stats

Obtenga las estadísticas de un centro de IoT.

Obtenga las estadísticas de un centro de IoT.

get_valid_skus

Obtenga la lista de SKU válidas para un centro de IoT.

Obtenga la lista de SKU válidas para un centro de IoT.

import_devices

Importe, actualice o elimine identidades de dispositivo en el registro de identidades de IoT Hub desde un blob. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Importe, actualice o elimine identidades de dispositivo en el registro de identidades de IoT Hub desde un blob. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

list_by_resource_group

Obtenga todos los centros de IoT de un grupo de recursos.

Obtenga todos los centros de IoT de un grupo de recursos.

list_by_subscription

Obtenga todos los centros de IoT de una suscripción.

Obtenga todos los centros de IoT de una suscripción.

list_event_hub_consumer_groups

Obtenga una lista de los grupos de consumidores en el punto de conexión de dispositivo a nube compatible con Event Hubs en un centro de IoT.

Obtenga una lista de los grupos de consumidores en el punto de conexión de dispositivo a nube compatible con Event Hubs en un centro de IoT.

list_jobs

Obtenga una lista de todos los trabajos de un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Obtenga una lista de todos los trabajos de un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

list_keys

Obtenga los metadatos de seguridad de un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Obtenga los metadatos de seguridad de un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

begin_create_or_update

Cree o actualice los metadatos de un centro de IoT.

Cree o actualice los metadatos de un centro de IoT. El patrón habitual para modificar una propiedad es recuperar los metadatos de IoT Hub y los metadatos de seguridad y, después, combinarlos con los valores modificados en un nuevo cuerpo para actualizar el centro de IoT. Si faltan determinadas propiedades en json, la actualización de IoT Hub puede provocar que estos valores se realicen de forma predeterminada, lo que puede provocar un comportamiento inesperado.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT que se va a crear o actualizar. Obligatorio.

iot_hub_description
IotHubDescription o IO
Requerido

Metadatos de IoT Hub y metadatos de seguridad. Es un tipo IotHubDescription o un tipo de E/S. Obligatorio.

content_type
str

Body Parameter content-type. Los valores conocidos son: "application/json", "text/json". El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o AsyncPollingMethod

De forma predeterminada, el método de sondeo será AsyncARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de AsyncLROPoller que devuelve IotHubDescription o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

begin_delete

Elimine un centro de IoT.

Elimine un centro de IoT.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT que se va a eliminar. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

continuation_token
str

Token de continuación para reiniciar un sondeo desde un estado guardado.

polling
bool o AsyncPollingMethod

De forma predeterminada, el método de sondeo será AsyncARMPolling. Pase False para que esta operación no sondee o pase su propio objeto de sondeo inicializado para una estrategia de sondeo personal.

polling_interval
int

Tiempo de espera predeterminado entre dos sondeos para las operaciones LRO si no hay ningún encabezado Retry-After presente.

Devoluciones

Instancia de AsyncLROPoller que devuelve IotHubDescription o Una instancia de AsyncLROPoller que devuelve ErrorDetails o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

check_name_availability

Compruebe si hay disponible un nombre de centro de IoT.

Compruebe si hay disponible un nombre de centro de IoT.

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

Parámetros

operation_inputs
OperationInputs o IO
Requerido

Establezca el parámetro name en la estructura OperationInputs en el nombre del centro de IoT que se va a comprobar. Es un tipo OperationInputs o un tipo de E/S. Obligatorio.

content_type
str

Body Parameter content-type. Los valores conocidos son: "application/json", "text/json". El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

Devoluciones

IotHubNameAvailabilityInfo o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

create_event_hub_consumer_group

Agregue un grupo de consumidores a un punto de conexión compatible con Event Hubs en un centro de IoT.

Agregue un grupo de consumidores a un punto de conexión compatible con Event Hubs en un centro de IoT.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

event_hub_endpoint_name
str
Requerido

Nombre del punto de conexión compatible con Event Hubs en IoT Hub. Obligatorio.

name
str
Requerido

Nombre del grupo de consumidores que se va a agregar. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

Devoluciones

EventHubConsumerGroupInfo o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

delete_event_hub_consumer_group

Elimine un grupo de consumidores de un punto de conexión compatible con Event Hubs en un centro de IoT.

Elimine un grupo de consumidores de un punto de conexión compatible con Event Hubs en un centro de IoT.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

event_hub_endpoint_name
str
Requerido

Nombre del punto de conexión compatible con Event Hubs en IoT Hub. Obligatorio.

name
str
Requerido

Nombre del grupo de consumidores que se va a eliminar. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

Devoluciones

Ninguno o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

export_devices

Exporta todas las identidades de dispositivo del registro de identidades de IoT Hub a un contenedor de blobs de Azure Storage. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Exporta todas las identidades de dispositivo del registro de identidades de IoT Hub a un contenedor de blobs de Azure Storage. Para obtener más información, consulte: 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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

export_devices_parameters
ExportDevicesRequest o IO
Requerido

Parámetros que especifican la operación de exportación de dispositivos. Es un tipo ExportDevicesRequest o un tipo de E/S. Obligatorio.

content_type
str

Body Parameter content-type. Los valores conocidos son: "application/json", "text/json". El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

Devoluciones

JobResponse o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

get

Obtenga los metadatos no relacionados con la seguridad de un centro de IoT.

Obtenga los metadatos no relacionados con la seguridad de un centro de IoT.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

Devoluciones

IotHubDescription o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

get_event_hub_consumer_group

Obtenga un grupo de consumidores del punto de conexión de dispositivo a nube compatible con Event Hubs para un centro de IoT.

Obtenga un grupo de consumidores del punto de conexión de dispositivo a nube compatible con Event Hubs para un centro de IoT.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

event_hub_endpoint_name
str
Requerido

Nombre del punto de conexión compatible con Event Hubs en el centro de IoT. Obligatorio.

name
str
Requerido

Nombre del grupo de consumidores que se va a recuperar. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

EventHubConsumerGroupInfo o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

get_job

Obtenga los detalles de un trabajo de un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Obtenga los detalles de un trabajo de un centro de IoT. Para obtener más información, consulte: 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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

job_id
str
Requerido

Identificador de trabajo. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

JobResponse o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

get_keys_for_key_name

Obtenga una directiva de acceso compartido por su nombre desde un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Obtenga una directiva de acceso compartido por su nombre desde un centro de IoT. Para obtener más información, consulte: 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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

key_name
str
Requerido

Nombre de la directiva de acceso compartido. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

SharedAccessSignatureAuthorizationRule o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

get_quota_metrics

Obtenga las métricas de cuota de un centro de IoT.

Obtenga las métricas de cuota de un centro de IoT.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

Iterador como una instancia de IotHubQuotaMetricInfo o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

get_stats

Obtenga las estadísticas de un centro de IoT.

Obtenga las estadísticas de un centro de IoT.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

RegistryStatistics o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

get_valid_skus

Obtenga la lista de SKU válidas para un centro de IoT.

Obtenga la lista de SKU válidas para un centro de IoT.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

Iterador como una instancia de IotHubSkuDescription o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

import_devices

Importe, actualice o elimine identidades de dispositivo en el registro de identidades de IoT Hub desde un blob. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Importe, actualice o elimine identidades de dispositivo en el registro de identidades de IoT Hub desde un blob. Para obtener más información, consulte: 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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

import_devices_parameters
ImportDevicesRequest o IO
Requerido

Parámetros que especifican la operación de importación de dispositivos. Es un tipo ImportDevicesRequest o un tipo de E/S. Obligatorio.

content_type
str

Tipo de contenido del parámetro body. Los valores conocidos son: "application/json", "text/json". El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

JobResponse o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

list_by_resource_group

Obtenga todos los centros de IoT de un grupo de recursos.

Obtenga todos los centros de IoT de un grupo de recursos.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene los centros de IoT. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

Iterador como una instancia de IotHubDescription o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

list_by_subscription

Obtenga todos los centros de IoT de una suscripción.

Obtenga todos los centros de IoT de una suscripción.

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

Parámetros

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

Iterador como una instancia de IotHubDescription o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

list_event_hub_consumer_groups

Obtenga una lista de los grupos de consumidores en el punto de conexión de dispositivo a nube compatible con Event Hubs en un centro de IoT.

Obtenga una lista de los grupos de consumidores en el punto de conexión de dispositivo a nube compatible con Event Hubs en un centro de IoT.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

event_hub_endpoint_name
str
Requerido

Nombre del punto de conexión compatible con Event Hubs. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

Iterador como una instancia de str o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

list_jobs

Obtenga una lista de todos los trabajos de un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Obtenga una lista de todos los trabajos de un centro de IoT. Para obtener más información, consulte: 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]

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

Iterador como una instancia de JobResponse o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

list_keys

Obtenga los metadatos de seguridad de un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Obtenga los metadatos de seguridad de un centro de IoT. Para obtener más información, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

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

Parámetros

resource_group_name
str
Requerido

Nombre del grupo de recursos que contiene el centro de IoT. Obligatorio.

resource_name
str
Requerido

Nombre del centro de IoT. Obligatorio.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa

Devoluciones

Iterador como una instancia de SharedAccessSignatureAuthorizationRule o el resultado de cls(response)

Tipo de valor devuelto

Excepciones

Atributos

models

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