IotHubResourceOperations Classe

Aviso

NÃO instancia esta classe diretamente.

Em vez disso, deve aceder às seguintes operações através de

IotHubClient's

<xref:iot_hub_resource> atributo.

Herança

builtins.object

IotHubResourceOperations

Construtor

IotHubResourceOperations(*args, **kwargs)

Métodos

begin_create_or_update	Criar ou atualizar 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 revertam para a predefinição, o que pode levar a um comportamento inesperado.
begin_delete	Eliminar um hub IoT. Eliminar um hub IoT.
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_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.

begin_create_or_update

Criar ou atualizar 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 revertam 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, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.IotHubDescription]

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT a criar ou atualizar. Obrigatório.

iot_hub_description

IotHubDescription ou IO

Necessário

Os metadados do hub IoT e os metadados de segurança. É um tipo IotHubDescription 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 à 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 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 estiver presente nenhum cabeçalho de Retry-After.

Devoluções

Uma instância do LROPoller que devolve IotHubDescription ou o resultado de cls(response)

Tipo de retorno

LROPoller[IotHubDescription]

Exceções

HttpResponseError

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

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT a eliminar. Obrigatório.

cls

callable

Um tipo ou função personalizado que será transmitido à 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 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 estiver presente 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(response)

Tipo de retorno

LROPoller[IotHubDescription],

LROPoller[ErrorDetails]

Exceções

HttpResponseError

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.IotHubNameAvailabilityInfo

Parâmetros

operation_inputs

OperationInputs ou IO

Necessário

Defina o parâmetro name na estrutura OperationInputs para 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 à resposta direta

Devoluções

IotHubNameAvailabilityInfo ou o resultado de cls(response)

Tipo de retorno

IotHubNameAvailabilityInfo

Exceções

HttpResponseError

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) -> EventHubConsumerGroupInfo

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

event_hub_endpoint_name

str

Necessário

O nome do ponto final compatível com o Hub de Eventos no hub IoT. Obrigatório.

name

str

Necessário

O nome do grupo de consumidores a adicionar. 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

EventHubConsumerGroupInfo

Exceções

HttpResponseError

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) -> None

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

event_hub_endpoint_name

str

Necessário

O nome do ponto final compatível com o Hub de Eventos no hub IoT. Obrigatório.

name

str

Necessário

O nome do grupo de consumidores a eliminar. Obrigatório.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

Nenhum ou o resultado de cls(response)

Tipo de retorno

None

Exceções

HttpResponseError

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.JobResponse

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

export_devices_parameters

ExportDevicesRequest ou IO

Necessário

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

JobResponse

Exceções

HttpResponseError

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) -> IotHubDescription

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

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

IotHubDescription

Exceções

HttpResponseError

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) -> EventHubConsumerGroupInfo

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

event_hub_endpoint_name

str

Necessário

O nome do ponto final compatível com o Hub de Eventos no hub IoT. Obrigatório.

name

str

Necessário

O nome do grupo de consumidores a obter. 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

EventHubConsumerGroupInfo

Exceções

HttpResponseError

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) -> JobResponse

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

job_id

str

Necessário

O identificador da tarefa. Obrigatório.

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

JobResponse

Exceções

HttpResponseError

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) -> SharedAccessSignatureAuthorizationRule

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

key_name

str

Necessário

O nome da política de acesso partilhado. Obrigatório.

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

SharedAccessSignatureAuthorizationRule

Exceções

HttpResponseError

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

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

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

ItemPaged[IotHubQuotaMetricInfo]

Exceções

HttpResponseError

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) -> RegistryStatistics

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

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

RegistryStatistics

Exceções

HttpResponseError

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

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

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

ItemPaged[IotHubSkuDescription]

Exceções

HttpResponseError

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.JobResponse

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

import_devices_parameters

ImportDevicesRequest ou IO

Necessário

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 à resposta direta

Devoluções

JobResponse ou o resultado de cls(response)

Tipo de retorno

JobResponse

Exceções

HttpResponseError

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

resource_group_name

str

Necessário

O nome do grupo de recursos que contém os hubs IoT. Obrigatório.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

Um iterador como a instância de IotHubDescription ou o resultado de cls(response)

Tipo de retorno

ItemPaged[IotHubDescription]

Exceções

HttpResponseError

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 à resposta direta

Devoluções

Um iterador como a instância de IotHubDescription ou o resultado de cls(response)

Tipo de retorno

ItemPaged[IotHubDescription]

Exceções

HttpResponseError

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

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

event_hub_endpoint_name

str

Necessário

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 à resposta direta

Devoluções

Um iterador como a instância de str ou o resultado de cls(response)

Tipo de retorno

ItemPaged[str]

Exceções

HttpResponseError

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

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

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

ItemPaged[JobResponse]

Exceções

HttpResponseError

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

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o hub IoT. Obrigatório.

resource_name

str

Necessário

O nome do hub IoT. Obrigatório.

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

ItemPaged[SharedAccessSignatureAuthorizationRule]

Exceções

HttpResponseError

Atributos

models

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