IotHubResourceOperations Classe

Aviso

NÃO instancie essa classe diretamente.

Em vez disso, você deve acessar as operações a seguir por meio de

IotHubClient's

Atributo <xref:iot_hub_resource>.

Herança

builtins.object

IotHubResourceOperations

Construtor

IotHubResourceOperations(*args, **kwargs)

Métodos

begin_create_or_update	Crie ou atualize os metadados de um hub IoT. Crie ou atualize os metadados de um hub Iot. O padrão usual para modificar uma propriedade é recuperar os metadados do Hub IoT e os metadados de segurança e, em seguida, combiná-los com os valores modificados em um novo corpo para atualizar o hub IoT.
begin_delete	Exclua um hub IoT. Exclua um hub IoT.
begin_update	Atualize as marcas existentes dos Hubs IoT. Atualize uma marca de Hub IoT existente. para atualizar outros campos, use o método CreateOrUpdate.
check_name_availability	Verifique se um nome de hub IoT está disponível. Verifique se um nome de hub IoT está disponível.
create_event_hub_consumer_group	Adicione um grupo de consumidores a um ponto de extremidade compatível com o Hub de Eventos em um hub IoT. Adicione um grupo de consumidores a um ponto de extremidade compatível com o Hub de Eventos em um hub IoT.
delete_event_hub_consumer_group	Exclua um grupo de consumidores de um ponto de extremidade compatível com o Hub de Eventos em um Hub IoT. Exclua um grupo de consumidores de um ponto de extremidade compatível com o Hub de Eventos em um Hub IoT.
export_devices	Exporta todas as identidades de dispositivo no registro de identidade do Hub IoT para um contêiner de blob do Armazenamento do Azure. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Exporta todas as identidades de dispositivo no registro de identidade do Hub IoT para um contêiner de blob do Armazenamento do Azure. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.
get	Obtenha os metadados não relacionados à segurança de um Hub IoT. Obtenha os metadados não relacionados à segurança de um Hub IoT.
get_endpoint_health	Obtenha a integridade dos pontos de extremidade de roteamento. Obtenha a integridade dos pontos de extremidade de roteamento.
get_event_hub_consumer_group	Obtenha um grupo de consumidores do ponto de extremidade do dispositivo para a nuvem compatível com o Hub de Eventos para um Hub IoT. Obtenha um grupo de consumidores do ponto de extremidade do dispositivo para a nuvem compatível com o Hub de Eventos para um Hub IoT.
get_job	Obtenha os detalhes de um trabalho de um hub IoT. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Obtenha os detalhes de um trabalho de um hub IoT. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
get_keys_for_key_name	Obtenha uma política de acesso compartilhado pelo nome de um hub IoT. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Obtenha uma política de acesso compartilhado pelo nome de um hub IoT. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
get_quota_metrics	Obtenha as métricas de cota para um Hub IoT. Obtenha as métricas de cota 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álidas para um hub IoT. Obtenha a lista de SKUs válidas para um hub IoT.
import_devices	Importar, atualizar ou excluir identidades de dispositivo no registro de identidade do Hub IoT de um blob. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Importar, atualizar ou excluir identidades de dispositivo no registro de identidade do Hub IoT de um blob. Para saber mais, confira 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 em um grupo de recursos. Obtenha todos os hubs IoT em um grupo de recursos.
list_by_subscription	Obtenha todos os hubs IoT em uma assinatura. Obtenha todos os hubs IoT em uma assinatura.
list_event_hub_consumer_groups	Obtenha uma lista dos grupos de consumidores no ponto de extremidade do dispositivo para nuvem compatível com o Hub de Eventos em um hub IoT. Obtenha uma lista dos grupos de consumidores no ponto de extremidade do dispositivo para nuvem compatível com o Hub de Eventos em um hub IoT.
list_jobs	Obtenha uma lista de todos os trabalhos em um hub IoT. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Obtenha uma lista de todos os trabalhos em um hub IoT. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.
list_keys	Obtenha os metadados de segurança para um Hub IoT. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Obtenha os metadados de segurança para um Hub IoT. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
test_all_routes	Teste todas as rotas. Teste todas as rotas configuradas neste Hub IoT.
test_route	Teste a nova rota. Teste a nova rota para esse Hub IoT.

begin_create_or_update

Crie ou atualize os metadados de um hub IoT.

Crie ou atualize os metadados de um hub Iot. O padrão usual para modificar uma propriedade é recuperar os metadados do Hub IoT e os metadados de segurança e, em seguida, combiná-los com os valores modificados em um novo corpo para atualizar o hub IoT.

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

Parâmetros

resource_group_name

str

Obrigatório

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

resource_name

str

Obrigatório

O nome do hub IoT. Obrigatórios.

iot_hub_description

IotHubDescription ou IO

Obrigatório

Os metadados do Hub IoT e os metadados de segurança. É um tipo IotHubDescription ou um tipo de E/S. Obrigatórios.

if_match

str

Obrigatório

ETag do Hub IoT. Não especifique para criar um novo Hub IoT. Necessário para atualizar um Hub IoT existente. O valor padrão é Nenhum.

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

continuation_token

str

Um token de continuação para reiniciar um poller de um estado salvo.

polling

bool ou AsyncPollingMethod

Por padrão, seu método de sondagem será AsyncARMPolling. Passe em False para que esta operação não sondar ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.

polling_interval

int

Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.

Retornos

Uma instância de AsyncLROPoller que retorna IotHubDescription ou o resultado de cls(response)

Tipo de retorno

AsyncLROPoller[IotHubDescription]

Exceções

HttpResponseError

begin_delete

Exclua um hub IoT.

Exclua um hub IoT.

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

Parâmetros

resource_group_name

str

Obrigatório

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

resource_name

str

Obrigatório

O nome do hub IoT. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

continuation_token

str

Um token de continuação para reiniciar um poller de um estado salvo.

polling

bool ou AsyncPollingMethod

Por padrão, seu método de sondagem será AsyncARMPolling. Passe em False para que esta operação não sondar ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.

polling_interval

int

Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.

Retornos

Uma instância de AsyncLROPoller que retorna IotHubDescription ou Uma instância de AsyncLROPoller que retorna ErrorDetails ou o resultado de cls(response)

Tipo de retorno

AsyncLROPoller[IotHubDescription],

AsyncLROPoller[ErrorDetails]

Exceções

HttpResponseError

begin_update

Atualize as marcas existentes dos Hubs IoT.

Atualize uma marca de Hub IoT existente. para atualizar outros campos, use o método CreateOrUpdate.

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

Parâmetros

resource_group_name

str

Obrigatório

Identificador do grupo de recursos. Obrigatórios.

resource_name

str

Obrigatório

Nome do hub iot a ser atualizado. Obrigatórios.

iot_hub_tags

TagsResource ou IO

Obrigatório

Informações de marca atualizadas para definir na instância do hub iot. É um tipo TagsResource ou um tipo de E/S. Obrigatórios.

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

continuation_token

str

Um token de continuação para reiniciar um poller de um estado salvo.

polling

bool ou AsyncPollingMethod

Por padrão, seu método de sondagem será AsyncARMPolling. Passe em False para que esta operação não sondar ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.

polling_interval

int

Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.

Retornos

Uma instância de AsyncLROPoller que retorna IotHubDescription ou o resultado de cls(response)

Tipo de retorno

AsyncLROPoller[IotHubDescription]

Exceções

HttpResponseError

check_name_availability

Verifique se um nome de hub IoT está disponível.

Verifique se um nome de hub IoT está disponível.

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

Parâmetros

operation_inputs

OperationInputs ou IO

Obrigatório

Defina o parâmetro name na estrutura OperationInputs como o nome do hub IoT como marcar. É um tipo OperationInputs ou um tipo de E/S. Obrigatórios.

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

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 de extremidade compatível com o Hub de Eventos em um hub IoT.

Adicione um grupo de consumidores a um ponto de extremidade compatível com o Hub de Eventos em um hub IoT.

async create_event_hub_consumer_group(resource_group_name: str, resource_name: str, event_hub_endpoint_name: str, name: str, consumer_group_body: _models.EventHubConsumerGroupBodyDescription, *, content_type: str = 'application/json', **kwargs: Any) -> _models.EventHubConsumerGroupInfo

Parâmetros

resource_group_name

str

Obrigatório

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

resource_name

str

Obrigatório

O nome do hub IoT. Obrigatórios.

event_hub_endpoint_name

str

Obrigatório

O nome do ponto de extremidade compatível com o Hub de Eventos no Hub IoT. Obrigatórios.

name

str

Obrigatório

O nome do grupo de consumidores a ser adicionado. Obrigatórios.

consumer_group_body

EventHubConsumerGroupBodyDescription ou IO

Obrigatório

O grupo de consumidores a ser adicionado. É um tipo EventHubConsumerGroupBodyDescription ou um tipo de E/S. Obrigatórios.

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

EventHubConsumerGroupInfo ou o resultado de cls(response)

Tipo de retorno

EventHubConsumerGroupInfo

Exceções

HttpResponseError

delete_event_hub_consumer_group

Exclua um grupo de consumidores de um ponto de extremidade compatível com o Hub de Eventos em um Hub IoT.

Exclua um grupo de consumidores de um ponto de extremidade compatível com o Hub de Eventos em um Hub IoT.

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

Parâmetros

resource_group_name

str

Obrigatório

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

resource_name

str

Obrigatório

O nome do hub IoT. Obrigatórios.

event_hub_endpoint_name

str

Obrigatório

O nome do ponto de extremidade compatível com o Hub de Eventos no Hub IoT. Obrigatórios.

name

str

Obrigatório

O nome do grupo de consumidores a ser excluído. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Nenhum ou o resultado de cls(response)

Tipo de retorno

None

Exceções

HttpResponseError

export_devices

Exporta todas as identidades de dispositivo no registro de identidade do Hub IoT para um contêiner de blob do Armazenamento do Azure. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Exporta todas as identidades de dispositivo no registro de identidade do Hub IoT para um contêiner de blob do Armazenamento do Azure. Para saber mais, confira 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

Obrigatório

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

resource_name

str

Obrigatório

O nome do Hub IoT. Obrigatórios.

export_devices_parameters

ExportDevicesRequest ou IO

Obrigatório

Os parâmetros que especificam a operação de exportação de dispositivos. É um tipo ExportDevicesRequest ou um tipo de E/S. Obrigatórios.

content_type

str

Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

JobResponse ou o resultado de cls(response)

Tipo de retorno

JobResponse

Exceções

HttpResponseError

get

Obtenha os metadados não relacionados à segurança de um Hub IoT.

Obtenha os metadados não relacionados à segurança de um Hub IoT.

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

Parâmetros

resource_group_name

str

Obrigatório

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

resource_name

str

Obrigatório

O nome do Hub IoT. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

IotHubDescription ou o resultado de cls(response)

Tipo de retorno

IotHubDescription

Exceções

HttpResponseError

get_endpoint_health

Obtenha a integridade dos pontos de extremidade de roteamento.

Obtenha a integridade dos pontos de extremidade de roteamento.

get_endpoint_health(resource_group_name: str, iot_hub_name: str, **kwargs: Any) -> AsyncIterable[EndpointHealthData]

Parâmetros

resource_group_name

str

Obrigatório

Obrigatórios.

iot_hub_name

str

Obrigatório

Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

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

Tipo de retorno

AsyncItemPaged[EndpointHealthData]

Exceções

HttpResponseError

get_event_hub_consumer_group

Obtenha um grupo de consumidores do ponto de extremidade do dispositivo para a nuvem compatível com o Hub de Eventos para um Hub IoT.

Obtenha um grupo de consumidores do ponto de extremidade do dispositivo para a nuvem compatível com o Hub de Eventos para um Hub IoT.

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

Parâmetros

resource_group_name

str

Obrigatório

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

resource_name

str

Obrigatório

O nome do Hub IoT. Obrigatórios.

event_hub_endpoint_name

str

Obrigatório

O nome do ponto de extremidade compatível com o Hub de Eventos no Hub IoT. Obrigatórios.

name

str

Obrigatório

O nome do grupo de consumidores a ser recuperado. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

EventHubConsumerGroupInfo ou o resultado de cls(response)

Tipo de retorno

EventHubConsumerGroupInfo

Exceções

HttpResponseError

get_job

Obtenha os detalhes de um trabalho de um hub IoT. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Obtenha os detalhes de um trabalho de um hub IoT. Para saber mais, confira 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

Obrigatório

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

resource_name

str

Obrigatório

O nome do Hub IoT. Obrigatórios.

job_id

str

Obrigatório

O identificador do trabalho. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

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 compartilhado pelo nome de um hub IoT. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Obtenha uma política de acesso compartilhado pelo nome de um hub IoT. Para saber mais, confira 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

Obrigatório

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

resource_name

str

Obrigatório

O nome do Hub IoT. Obrigatórios.

key_name

str

Obrigatório

O nome da política de acesso compartilhado. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

SharedAccessSignatureAuthorizationRule ou o resultado de cls(response)

Tipo de retorno

SharedAccessSignatureAuthorizationRule

Exceções

HttpResponseError

get_quota_metrics

Obtenha as métricas de cota para um Hub IoT.

Obtenha as métricas de cota para um Hub IoT.

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

Parâmetros

resource_group_name

str

Obrigatório

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

resource_name

str

Obrigatório

O nome do Hub IoT. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

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

Tipo de retorno

AsyncItemPaged[IotHubQuotaMetricInfo]

Exceções

HttpResponseError

get_stats

Obtenha as estatísticas de um hub IoT.

Obtenha as estatísticas de um hub IoT.

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

Parâmetros

resource_group_name

str

Obrigatório

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

resource_name

str

Obrigatório

O nome do Hub IoT. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

RegistryStatistics ou o resultado de cls(response)

Tipo de retorno

RegistryStatistics

Exceções

HttpResponseError

get_valid_skus

Obtenha a lista de SKUs válidas para um hub IoT.

Obtenha a lista de SKUs válidas para um hub IoT.

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

Parâmetros

resource_group_name

str

Obrigatório

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

resource_name

str

Obrigatório

O nome do Hub IoT. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

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

Tipo de retorno

AsyncItemPaged[IotHubSkuDescription]

Exceções

HttpResponseError

import_devices

Importar, atualizar ou excluir identidades de dispositivo no registro de identidade do Hub IoT de um blob. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

Importar, atualizar ou excluir identidades de dispositivo no registro de identidade do Hub IoT de um blob. Para saber mais, confira 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

Obrigatório

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

resource_name

str

Obrigatório

O nome do Hub IoT. Obrigatórios.

import_devices_parameters

ImportDevicesRequest ou IO

Obrigatório

Os parâmetros que especificam a operação de importação de dispositivos. É um tipo ImportDevicesRequest ou um tipo de E/S. Obrigatórios.

content_type

str

Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

JobResponse ou o resultado de cls(response)

Tipo de retorno

JobResponse

Exceções

HttpResponseError

list_by_resource_group

Obtenha todos os hubs IoT em um grupo de recursos.

Obtenha todos os hubs IoT em um grupo de recursos.

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

Parâmetros

resource_group_name

str

Obrigatório

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

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

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

Tipo de retorno

AsyncItemPaged[IotHubDescription]

Exceções

HttpResponseError

list_by_subscription

Obtenha todos os hubs IoT em uma assinatura.

Obtenha todos os hubs IoT em uma assinatura.

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

Parâmetros

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

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

Tipo de retorno

AsyncItemPaged[IotHubDescription]

Exceções

HttpResponseError

list_event_hub_consumer_groups

Obtenha uma lista dos grupos de consumidores no ponto de extremidade do dispositivo para nuvem compatível com o Hub de Eventos em um hub IoT.

Obtenha uma lista dos grupos de consumidores no ponto de extremidade do dispositivo para nuvem compatível com o Hub de Eventos em um hub IoT.

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

Parâmetros

resource_group_name

str

Obrigatório

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

resource_name

str

Obrigatório

O nome do Hub IoT. Obrigatórios.

event_hub_endpoint_name

str

Obrigatório

O nome do ponto de extremidade compatível com o Hub de Eventos. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

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

Tipo de retorno

AsyncItemPaged[EventHubConsumerGroupInfo]

Exceções

HttpResponseError

list_jobs

Obtenha uma lista de todos os trabalhos em um hub IoT. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

Obtenha uma lista de todos os trabalhos em um hub IoT. Para saber mais, confira 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

Obrigatório

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

resource_name

str

Obrigatório

O nome do Hub IoT. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

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

Tipo de retorno

AsyncItemPaged[JobResponse]

Exceções

HttpResponseError

list_keys

Obtenha os metadados de segurança para um Hub IoT. Para saber mais, confira https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Obtenha os metadados de segurança para um Hub IoT. Para saber mais, confira 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

Obrigatório

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

resource_name

str

Obrigatório

O nome do Hub IoT. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

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

Tipo de retorno

AsyncItemPaged[SharedAccessSignatureAuthorizationRule]

Exceções

HttpResponseError

test_all_routes

Teste todas as rotas.

Teste todas as rotas configuradas neste Hub IoT.

async test_all_routes(iot_hub_name: str, resource_group_name: str, input: _models.TestAllRoutesInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestAllRoutesResult

Parâmetros

iot_hub_name

str

Obrigatório

IotHub a ser testado. Obrigatórios.

resource_group_name

str

Obrigatório

grupo de recursos ao qual o Hub Iot pertence. Obrigatórios.

input

TestAllRoutesInput ou IO

Obrigatório

Entrada para testar todas as rotas. É um tipo TestAllRoutesInput ou um tipo de E/S. Obrigatórios.

content_type

str

Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

TestAllRoutesResult ou o resultado de cls(response)

Tipo de retorno

TestAllRoutesResult

Exceções

HttpResponseError

test_route

Teste a nova rota.

Teste a nova rota para esse Hub IoT.

async test_route(iot_hub_name: str, resource_group_name: str, input: _models.TestRouteInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestRouteResult

Parâmetros

iot_hub_name

str

Obrigatório

IotHub a ser testado. Obrigatórios.

resource_group_name

str

Obrigatório

grupo de recursos ao qual o Hub Iot pertence. Obrigatórios.

input

TestRouteInput ou IO

Obrigatório

Rota que precisa ser testada. É um tipo TestRouteInput ou um tipo de E/S. Obrigatórios.

content_type

str

Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

TestRouteResult ou o resultado de cls(response)

Tipo de retorno

TestRouteResult

Exceções

HttpResponseError

Atributos

models

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