IotHubResource interface
Interface que representa um IotHubResource.
Métodos
| begin |
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. Se determinadas propriedades estiverem ausentes no JSON, atualizar Hub IoT poderá fazer com que esses valores sejam fallback como padrão, o que pode levar a um comportamento inesperado. |
| begin |
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. Se determinadas propriedades estiverem ausentes no JSON, atualizar Hub IoT poderá fazer com que esses valores sejam fallback como padrão, o que pode levar a um comportamento inesperado. |
| begin |
Exclua um hub IoT. |
| begin |
Exclua um hub IoT. |
| begin |
Atualize uma marca de Hub IoT existente. para atualizar outros campos, use o método CreateOrUpdate |
| begin |
Atualize uma marca de Hub IoT existente. para atualizar outros campos, use o método CreateOrUpdate |
| check |
Verifique se um nome de hub IoT está disponível. |
| create |
Adicione um grupo de consumidores a um ponto de extremidade compatível com o Hub de Eventos em um Hub IoT. |
| delete |
Exclua um grupo de consumidores de um ponto de extremidade compatível com o Hub de Eventos em um Hub IoT. |
| export |
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(string, string, Iot |
Obtenha os metadados não relacionados à segurança de um Hub IoT. |
| get |
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 |
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 |
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 |
Obtenha as estatísticas de um hub IoT. |
| import |
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 |
Obtenha todos os hubs IoT em um grupo de recursos. |
| list |
Obtenha todos os hubs IoT em uma assinatura. |
| list |
Obtenha a integridade dos pontos de extremidade de roteamento. |
| list |
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 |
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 |
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 |
Obtenha as métricas de cota para um Hub IoT. |
| list |
Obtenha a lista de SKUs válidas para um hub IoT. |
| test |
Testar todas as rotas configuradas neste Hub IoT |
| test |
Testar a nova rota para este Hub Iot |
Detalhes do método
beginCreateOrUpdate(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
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. Se determinadas propriedades estiverem ausentes no JSON, atualizar Hub IoT poderá fazer com que esses valores sejam fallback como padrão, o que pode levar a um comportamento inesperado.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotHubDescription>, IotHubDescription>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do hub IoT.
- iotHubDescription
- IotHubDescription
Os metadados do Hub IoT e os metadados de segurança.
Os parâmetros de opções.
Retornos
Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>
beginCreateOrUpdateAndWait(string, string, IotHubDescription, IotHubResourceCreateOrUpdateOptionalParams)
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. Se determinadas propriedades estiverem ausentes no JSON, atualizar Hub IoT poderá fazer com que esses valores sejam fallback como padrão, o que pode levar a um comportamento inesperado.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubDescription>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do hub IoT.
- iotHubDescription
- IotHubDescription
Os metadados do Hub IoT e os metadados de segurança.
Os parâmetros de opções.
Retornos
Promise<IotHubDescription>
beginDelete(string, string, IotHubResourceDeleteOptionalParams)
Exclua um hub IoT.
function beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<IotHubDescription>, IotHubDescription>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do hub IoT.
Os parâmetros de opções.
Retornos
Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>
beginDeleteAndWait(string, string, IotHubResourceDeleteOptionalParams)
Exclua um hub IoT.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubDescription>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do hub IoT.
Os parâmetros de opções.
Retornos
Promise<IotHubDescription>
beginUpdate(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Atualize uma marca de Hub IoT existente. para atualizar outros campos, use o método CreateOrUpdate
function beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotHubDescription>, IotHubDescription>>Parâmetros
- resourceGroupName
-
string
Identificador do grupo de recursos.
- resourceName
-
string
Nome do hub iot a ser atualizado.
- iotHubTags
- TagsResource
Informações de marca atualizadas para definir na instância do hub iot.
Os parâmetros de opções.
Retornos
Promise<PollerLike<@azure/core-lro.PollOperationState<IotHubDescription>, IotHubDescription>>
beginUpdateAndWait(string, string, TagsResource, IotHubResourceUpdateOptionalParams)
Atualize uma marca de Hub IoT existente. para atualizar outros campos, use o método CreateOrUpdate
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubDescription>Parâmetros
- resourceGroupName
-
string
Identificador do grupo de recursos.
- resourceName
-
string
Nome do hub iot a ser atualizado.
- iotHubTags
- TagsResource
Informações de marca atualizadas para definir na instância do hub iot.
Os parâmetros de opções.
Retornos
Promise<IotHubDescription>
checkNameAvailability(OperationInputs, IotHubResourceCheckNameAvailabilityOptionalParams)
Verifique se um nome de hub IoT está disponível.
function checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubNameAvailabilityInfo>Parâmetros
- operationInputs
- OperationInputs
Defina o parâmetro name na estrutura OperationInputs como o nome do hub IoT a ser verificado.
Os parâmetros de opções.
Retornos
Promise<IotHubNameAvailabilityInfo>
createEventHubConsumerGroup(string, string, string, string, IotHubResourceCreateEventHubConsumerGroupOptionalParams)
Adicione um grupo de consumidores a um ponto de extremidade compatível com o Hub de Eventos em um Hub IoT.
function createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
- eventHubEndpointName
-
string
O nome do ponto de extremidade compatível com o Hub de Eventos no Hub IoT.
- name
-
string
O nome do grupo de consumidores a ser adicionado.
Os parâmetros de opções.
Retornos
Promise<EventHubConsumerGroupInfo>
deleteEventHubConsumerGroup(string, string, string, string, IotHubResourceDeleteEventHubConsumerGroupOptionalParams)
Exclua um grupo de consumidores de um ponto de extremidade compatível com o Hub de Eventos em um Hub IoT.
function deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
- eventHubEndpointName
-
string
O nome do ponto de extremidade compatível com o Hub de Eventos no Hub IoT.
- name
-
string
O nome do grupo de consumidores a ser excluído.
Os parâmetros de opções.
Retornos
Promise<void>
exportDevices(string, string, ExportDevicesRequest, IotHubResourceExportDevicesOptionalParams)
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.
function exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: ExportDevicesRequest, options?: IotHubResourceExportDevicesOptionalParams): Promise<JobResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
- exportDevicesParameters
- ExportDevicesRequest
Os parâmetros que especificam a operação de exportação de dispositivos.
Os parâmetros de opções.
Retornos
Promise<JobResponse>
get(string, string, IotHubResourceGetOptionalParams)
Obtenha os metadados não relacionados à segurança de um Hub IoT.
function get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubDescription>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
- options
- IotHubResourceGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<IotHubDescription>
getEventHubConsumerGroup(string, string, string, string, IotHubResourceGetEventHubConsumerGroupOptionalParams)
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.
function getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<EventHubConsumerGroupInfo>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
- eventHubEndpointName
-
string
O nome do ponto de extremidade compatível com o Hub de Eventos no Hub IoT.
- name
-
string
O nome do grupo de consumidores a ser recuperado.
Os parâmetros de opções.
Retornos
Promise<EventHubConsumerGroupInfo>
getJob(string, string, string, IotHubResourceGetJobOptionalParams)
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.
function getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<JobResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
- jobId
-
string
O identificador do trabalho.
Os parâmetros de opções.
Retornos
Promise<JobResponse>
getKeysForKeyName(string, string, string, IotHubResourceGetKeysForKeyNameOptionalParams)
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.
function getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRule>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
- keyName
-
string
O nome da política de acesso compartilhado.
Os parâmetros de opções.
Retornos
getStats(string, string, IotHubResourceGetStatsOptionalParams)
Obtenha as estatísticas de um hub IoT.
function getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<RegistryStatistics>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
Os parâmetros de opções.
Retornos
Promise<RegistryStatistics>
importDevices(string, string, ImportDevicesRequest, IotHubResourceImportDevicesOptionalParams)
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.
function importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: ImportDevicesRequest, options?: IotHubResourceImportDevicesOptionalParams): Promise<JobResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
- importDevicesParameters
- ImportDevicesRequest
Os parâmetros que especificam a operação de importação de dispositivos.
Os parâmetros de opções.
Retornos
Promise<JobResponse>
listByResourceGroup(string, IotHubResourceListByResourceGroupOptionalParams)
Obtenha todos os hubs IoT em um grupo de recursos.
function listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
Os parâmetros de opções.
Retornos
listBySubscription(IotHubResourceListBySubscriptionOptionalParams)
Obtenha todos os hubs IoT em uma assinatura.
function listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription, IotHubDescription[], PageSettings>Parâmetros
Os parâmetros de opções.
Retornos
listEndpointHealth(string, string, IotHubResourceGetEndpointHealthOptionalParams)
Obtenha a integridade dos pontos de extremidade de roteamento.
function listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData, EndpointHealthData[], PageSettings>Parâmetros
- resourceGroupName
-
string
- iotHubName
-
string
Os parâmetros de opções.
Retornos
listEventHubConsumerGroups(string, string, string, IotHubResourceListEventHubConsumerGroupsOptionalParams)
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.
function listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo, EventHubConsumerGroupInfo[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
- eventHubEndpointName
-
string
O nome do ponto de extremidade compatível com o Hub de Eventos.
Os parâmetros de opções.
Retornos
listJobs(string, string, IotHubResourceListJobsOptionalParams)
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.
function listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse, JobResponse[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
Os parâmetros de opções.
Retornos
listKeys(string, string, IotHubResourceListKeysOptionalParams)
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.
function listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule, SharedAccessSignatureAuthorizationRule[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
Os parâmetros de opções.
Retornos
listQuotaMetrics(string, string, IotHubResourceGetQuotaMetricsOptionalParams)
Obtenha as métricas de cota para um Hub IoT.
function listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo, IotHubQuotaMetricInfo[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
Os parâmetros de opções.
Retornos
listValidSkus(string, string, IotHubResourceGetValidSkusOptionalParams)
Obtenha a lista de SKUs válidas para um hub IoT.
function listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription, IotHubSkuDescription[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o hub IoT.
- resourceName
-
string
O nome do Hub IoT.
Os parâmetros de opções.
Retornos
testAllRoutes(string, string, TestAllRoutesInput, IotHubResourceTestAllRoutesOptionalParams)
Testar todas as rotas configuradas neste Hub IoT
function testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<TestAllRoutesResult>Parâmetros
- iotHubName
-
string
IotHub a ser testado
- resourceGroupName
-
string
grupo de recursos ao qual o Hub Iot pertence
- input
- TestAllRoutesInput
Entrada para testar todas as rotas
Os parâmetros de opções.
Retornos
Promise<TestAllRoutesResult>
testRoute(string, string, TestRouteInput, IotHubResourceTestRouteOptionalParams)
Testar a nova rota para este Hub Iot
function testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<TestRouteResult>Parâmetros
- iotHubName
-
string
IotHub a ser testado
- resourceGroupName
-
string
grupo de recursos ao qual o Hub Iot pertence
- input
- TestRouteInput
Rota que precisa ser testada
Os parâmetros de opções.
Retornos
Promise<TestRouteResult>