IotHubResourceOperations Classe
Aviso
NÃO instancia esta classe diretamente.
Em vez disso, deve aceder às seguintes operações através de
<xref:iot_hub_resource> atributo.
- Herança
-
builtins.objectIotHubResourceOperations
Construtor
IotHubResourceOperations(*args, **kwargs)Métodos
| begin_create_or_update |
Crie ou atualize os metadados de um hub IoT. Criar ou atualizar os metadados de um hub Iot. O padrão habitual para modificar uma propriedade é obter os metadados e metadados de segurança do hub IoT e, em seguida, combiná-los com os valores modificados num novo corpo para atualizar o hub IoT. Se determinadas propriedades estiverem em falta no JSON, atualizar Hub IoT pode fazer com que estes valores recuem para a predefinição, o que pode levar a um comportamento inesperado. |
| begin_delete |
Eliminar um hub IoT. Eliminar um hub IoT. |
| begin_update |
Atualize as etiquetas dos Hubs IoT existentes. Atualizar etiquetas de Hub IoT existentes. para atualizar outros campos, utilize o método CreateOrUpdate. |
| check_name_availability |
Verifique se está disponível um nome de hub IoT. Verifique se está disponível um nome de hub IoT. |
| create_event_hub_consumer_group |
Adicione um grupo de consumidores a um ponto final compatível com o Hub de Eventos num hub IoT. Adicione um grupo de consumidores a um ponto final compatível com o Hub de Eventos num hub IoT. |
| delete_event_hub_consumer_group |
Elimine um grupo de consumidores de um ponto final compatível com o Hub de Eventos num hub IoT. Elimine um grupo de consumidores de um ponto final compatível com o Hub de Eventos num hub IoT. |
| export_devices |
Exporta todas as identidades do dispositivo no registo de identidades do hub IoT para um contentor de blobs do Armazenamento do Azure. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Exporta todas as identidades do dispositivo no registo de identidades do hub IoT para um contentor de blobs do Armazenamento do Azure. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. |
| get |
Obtenha os metadados não relacionados com segurança de um hub IoT. Obtenha os metadados não relacionados com segurança de um hub IoT. |
| get_endpoint_health |
Obtenha o estado de funcionamento dos pontos finais de encaminhamento. Obtenha o estado de funcionamento dos pontos finais de encaminhamento. |
| get_event_hub_consumer_group |
Obtenha um grupo de consumidores do ponto final do dispositivo para a cloud compatível com o Hub de Eventos para um hub IoT. Obtenha um grupo de consumidores do ponto final do dispositivo para a cloud compatível com o Hub de Eventos para um hub IoT. |
| get_job |
Obtenha os detalhes de uma tarefa a partir de um hub IoT. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Obtenha os detalhes de uma tarefa a partir de um hub IoT. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. |
| get_keys_for_key_name |
Obtenha uma política de acesso partilhado por nome a partir de um hub IoT. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Obtenha uma política de acesso partilhado por nome a partir de um hub IoT. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. |
| get_quota_metrics |
Obtenha as métricas de quota para um hub IoT. Obtenha as métricas de quota para um hub IoT. |
| get_stats |
Obtenha as estatísticas de um hub IoT. Obtenha as estatísticas de um hub IoT. |
| get_valid_skus |
Obtenha a lista de SKUs válidos para um hub IoT. Obtenha a lista de SKUs válidos para um hub IoT. |
| import_devices |
Importar, atualizar ou eliminar identidades de dispositivos no registo de identidades do hub IoT a partir de um blob. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Importar, atualizar ou eliminar identidades de dispositivos no registo de identidades do hub IoT a partir de um blob. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. |
| list_by_resource_group |
Obtenha todos os hubs IoT num grupo de recursos. Obtenha todos os hubs IoT num grupo de recursos. |
| list_by_subscription |
Obtenha todos os hubs IoT numa subscrição. Obtenha todos os hubs IoT numa subscrição. |
| list_event_hub_consumer_groups |
Obtenha uma lista dos grupos de consumidores no ponto final de dispositivo para cloud compatível com o Hub de Eventos num hub IoT. Obtenha uma lista dos grupos de consumidores no ponto final de dispositivo para cloud compatível com o Hub de Eventos num hub IoT. |
| list_jobs |
Obtenha uma lista de todas as tarefas num hub IoT. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Obtenha uma lista de todas as tarefas num hub IoT. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. |
| list_keys |
Obtenha os metadados de segurança de um hub IoT. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Obtenha os metadados de segurança de um hub IoT. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. |
| test_all_routes |
Testar todas as rotas. Teste todas as rotas configuradas neste Hub Iot. |
| test_route |
Teste a nova rota. Teste a nova rota para este Hub Iot. |
begin_create_or_update
Crie ou atualize os metadados de um hub IoT.
Criar ou atualizar os metadados de um hub Iot. O padrão habitual para modificar uma propriedade é obter os metadados e metadados de segurança do hub IoT e, em seguida, combiná-los com os valores modificados num novo corpo para atualizar o hub IoT. Se determinadas propriedades estiverem em falta no JSON, atualizar Hub IoT pode fazer com que estes valores recuem para a predefinição, o que pode levar a um comportamento inesperado.
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]Parâmetros
- iot_hub_description
- IotHubDescription ou IO
Os metadados do hub IoT e os metadados de segurança. É um tipo IotHubDescription ou um tipo de E/S. Obrigatório.
- if_match
- str
ETag do Hub IoT. Não especifique para criar um novo Hub IoT. Necessário para atualizar uma Hub IoT existente. O valor predefinido é Nenhum.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um poller a partir de um estado guardado.
- polling
- bool ou PollingMethod
Por predefinição, o seu método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.
- polling_interval
- int
Tempo de espera predefinido entre duas sondagens para operações LRO se não existir nenhum cabeçalho de Retry-After.
Devoluções
Uma instância do LROPoller que devolve IotHubDescription ou o resultado de cls(resposta)
Tipo de retorno
Exceções
begin_delete
Eliminar um hub IoT.
Eliminar um hub IoT.
begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> LROPoller[IotHubDescription]Parâmetros
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um poller a partir de um estado guardado.
- polling
- bool ou PollingMethod
Por predefinição, o seu método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.
- polling_interval
- int
Tempo de espera predefinido entre duas sondagens para operações LRO se não existir nenhum cabeçalho de Retry-After.
Devoluções
Uma instância do LROPoller que devolve IotHubDescription ou Uma instância do LROPoller que devolve ErrorDetails ou o resultado de cls(resposta)
Tipo de retorno
Exceções
begin_update
Atualize as etiquetas dos Hubs IoT existentes.
Atualizar etiquetas de Hub IoT existentes. para atualizar outros campos, utilize o método 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]Parâmetros
- iot_hub_tags
- TagsResource ou IO
Informações de etiqueta atualizadas para definir na instância do hub iot. É um tipo tagsResource ou um tipo de E/S. Obrigatório.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
- continuation_token
- str
Um token de continuação para reiniciar um poller a partir de um estado guardado.
- polling
- bool ou PollingMethod
Por predefinição, o seu método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.
- polling_interval
- int
Tempo de espera predefinido entre duas sondagens para operações LRO se não existir nenhum cabeçalho de Retry-After.
Devoluções
Uma instância do LROPoller que devolve IotHubDescription ou o resultado de cls(resposta)
Tipo de retorno
Exceções
check_name_availability
Verifique se está disponível um nome de hub IoT.
Verifique se está disponível um nome de hub IoT.
check_name_availability(operation_inputs: _models.OperationInputs, *, content_type: str = 'application/json', **kwargs: Any) -> _models.IotHubNameAvailabilityInfoParâmetros
- operation_inputs
- OperationInputs ou IO
Defina o parâmetro de nome na estrutura OperationInputs como o nome do hub IoT a verificar. É um tipo OperationInputs ou um tipo de E/S. Obrigatório.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
IotHubNameAvailabilityInfo ou o resultado de cls(response)
Tipo de retorno
Exceções
create_event_hub_consumer_group
Adicione um grupo de consumidores a um ponto final compatível com o Hub de Eventos num hub IoT.
Adicione um grupo de consumidores a um ponto final compatível com o Hub de Eventos num hub IoT.
create_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> EventHubConsumerGroupInfoParâmetros
- event_hub_endpoint_name
- str
O nome do ponto final compatível com o Hub de Eventos no hub IoT. Obrigatório.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
EventHubConsumerGroupInfo ou o resultado de cls(response)
Tipo de retorno
Exceções
delete_event_hub_consumer_group
Elimine um grupo de consumidores de um ponto final compatível com o Hub de Eventos num hub IoT.
Elimine um grupo de consumidores de um ponto final compatível com o Hub de Eventos num hub IoT.
delete_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> NoneParâmetros
- event_hub_endpoint_name
- str
O nome do ponto final compatível com o Hub de Eventos no hub IoT. Obrigatório.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
Nenhum ou o resultado de cls(resposta)
Tipo de retorno
Exceções
export_devices
Exporta todas as identidades do dispositivo no registo de identidades do hub IoT para um contentor de blobs do Armazenamento do Azure. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
Exporta todas as identidades do dispositivo no registo de identidades do hub IoT para um contentor de blobs do Armazenamento do Azure. Para obter mais informações, consulte: 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.JobResponseParâmetros
- export_devices_parameters
- ExportDevicesRequest ou IO
Os parâmetros que especificam a operação de exportação de dispositivos. É um tipo ExportDevicesRequest ou de E/S. Obrigatório.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
Devoluções
JobResponse ou o resultado de cls(response)
Tipo de retorno
Exceções
get
Obtenha os metadados não relacionados com segurança de um hub IoT.
Obtenha os metadados não relacionados com segurança de um hub IoT.
get(resource_group_name: str, resource_name: str, **kwargs: Any) -> IotHubDescriptionParâmetros
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
Devoluções
IotHubDescription ou o resultado de cls(response)
Tipo de retorno
Exceções
get_endpoint_health
Obtenha o estado de funcionamento dos pontos finais de encaminhamento.
Obtenha o estado de funcionamento dos pontos finais de encaminhamento.
get_endpoint_health(resource_group_name: str, iot_hub_name: str, **kwargs: Any) -> Iterable[EndpointHealthData]Parâmetros
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
Devoluções
Um iterador como a instância de EndpointHealthData ou o resultado de cls(response)
Tipo de retorno
Exceções
get_event_hub_consumer_group
Obtenha um grupo de consumidores do ponto final do dispositivo para a cloud compatível com o Hub de Eventos para um hub IoT.
Obtenha um grupo de consumidores do ponto final do dispositivo para a cloud compatível com o Hub de Eventos para um hub IoT.
get_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, **kwargs: Any) -> EventHubConsumerGroupInfoParâmetros
- event_hub_endpoint_name
- str
O nome do ponto final compatível com o Hub de Eventos no hub IoT. Obrigatório.
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
Devoluções
EventHubConsumerGroupInfo ou o resultado de cls(response)
Tipo de retorno
Exceções
get_job
Obtenha os detalhes de uma tarefa a partir de um hub IoT. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
Obtenha os detalhes de uma tarefa a partir de um hub IoT. Para obter mais informações, consulte: 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) -> JobResponseParâmetros
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
Devoluções
JobResponse ou o resultado de cls(response)
Tipo de retorno
Exceções
get_keys_for_key_name
Obtenha uma política de acesso partilhado por nome a partir de um hub IoT. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
Obtenha uma política de acesso partilhado por nome a partir de um hub IoT. Para obter mais informações, consulte: 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) -> SharedAccessSignatureAuthorizationRuleParâmetros
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
Devoluções
SharedAccessSignatureAuthorizationRule ou o resultado de cls(response)
Tipo de retorno
Exceções
get_quota_metrics
Obtenha as métricas de quota para um hub IoT.
Obtenha as métricas de quota para um hub IoT.
get_quota_metrics(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[IotHubQuotaMetricInfo]Parâmetros
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
Devoluções
Um iterador como a instância de IotHubQuotaMetricInfo ou o resultado de cls(response)
Tipo de retorno
Exceções
get_stats
Obtenha as estatísticas de um hub IoT.
Obtenha as estatísticas de um hub IoT.
get_stats(resource_group_name: str, resource_name: str, **kwargs: Any) -> RegistryStatisticsParâmetros
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
Devoluções
RegistryStatistics ou o resultado de cls(response)
Tipo de retorno
Exceções
get_valid_skus
Obtenha a lista de SKUs válidos para um hub IoT.
Obtenha a lista de SKUs válidos para um hub IoT.
get_valid_skus(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[IotHubSkuDescription]Parâmetros
- cls
- callable
Um tipo ou função personalizado que será transmitido à resposta direta
Devoluções
Um iterador como a instância de IotHubSkuDescription ou o resultado de cls(response)
Tipo de retorno
Exceções
import_devices
Importar, atualizar ou eliminar identidades de dispositivos no registo de identidades do hub IoT a partir de um blob. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
Importar, atualizar ou eliminar identidades de dispositivos no registo de identidades do hub IoT a partir de um blob. Para obter mais informações, consulte: 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.JobResponseParâmetros
- import_devices_parameters
- ImportDevicesRequest ou IO
Os parâmetros que especificam a operação de importação de dispositivos. É um tipo ImportDevicesRequest ou de E/S. Obrigatório.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
JobResponse ou o resultado de cls(resposta)
Tipo de retorno
Exceções
list_by_resource_group
Obtenha todos os hubs IoT num grupo de recursos.
Obtenha todos os hubs IoT num grupo de recursos.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[IotHubDescription]Parâmetros
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
Um iterador como a instância de IotHubDescription ou o resultado de cls(response)
Tipo de retorno
Exceções
list_by_subscription
Obtenha todos os hubs IoT numa subscrição.
Obtenha todos os hubs IoT numa subscrição.
list_by_subscription(**kwargs: Any) -> Iterable[IotHubDescription]Parâmetros
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
Um iterador como a instância de IotHubDescription ou o resultado de cls(response)
Tipo de retorno
Exceções
list_event_hub_consumer_groups
Obtenha uma lista dos grupos de consumidores no ponto final de dispositivo para cloud compatível com o Hub de Eventos num hub IoT.
Obtenha uma lista dos grupos de consumidores no ponto final de dispositivo para cloud compatível com o Hub de Eventos num hub IoT.
list_event_hub_consumer_groups(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, **kwargs: Any) -> Iterable[EventHubConsumerGroupInfo]Parâmetros
- event_hub_endpoint_name
- str
O nome do ponto final compatível com o Hub de Eventos. Obrigatório.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
Um iterador como a instância do EventHubConsumerGroupInfo ou o resultado de cls(response)
Tipo de retorno
Exceções
list_jobs
Obtenha uma lista de todas as tarefas num hub IoT. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
Obtenha uma lista de todas as tarefas num hub IoT. Para obter mais informações, consulte: 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]Parâmetros
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
Um iterador como a instância de JobResponse ou o resultado de cls(response)
Tipo de retorno
Exceções
list_keys
Obtenha os metadados de segurança de um hub IoT. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
Obtenha os metadados de segurança de um hub IoT. Para obter mais informações, consulte: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
list_keys(resource_group_name: str, resource_name: str, **kwargs: Any) -> Iterable[SharedAccessSignatureAuthorizationRule]Parâmetros
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
Um iterador como a instância de SharedAccessSignatureAuthorizationRule ou o resultado de cls(response)
Tipo de retorno
Exceções
test_all_routes
Testar todas as rotas.
Teste todas as rotas configuradas neste Hub Iot.
test_all_routes(iot_hub_name: str, resource_group_name: str, input: _models.TestAllRoutesInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestAllRoutesResultParâmetros
- input
- TestAllRoutesInput ou IO
Entrada para testar todas as rotas. É um tipo TestAllRoutesInput ou um tipo de E/S. Obrigatório.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
TestAllRoutesResult ou o resultado de cls(response)
Tipo de retorno
Exceções
test_route
Teste a nova rota.
Teste a nova rota para este Hub Iot.
test_route(iot_hub_name: str, resource_group_name: str, input: _models.TestRouteInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestRouteResultParâmetros
- input
- TestRouteInput ou IO
Rota que tem de ser testada. É um tipo testRouteInput ou um tipo de E/S. Obrigatório.
- content_type
- str
Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: "application/json". O valor predefinido é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será transmitido a resposta direta
Devoluções
TestRouteResult ou o resultado de cls(resposta)
Tipo de retorno
Exceções
Atributos
models
models = <module 'azure.mgmt.iothub.v2019_11_04.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\iothub\\v2019_11_04\\models\\__init__.py'>
Azure SDK for Python