Invoke-AzIotHubQuery

リファレンス

モジュール:: Az.IotHub

強力な SQL に似た言語を使用して、IoT Hub に対するクエリを実行します。

構文

Invoke-AzIotHubQuery
      [-ResourceGroupName] <String>
      [-IotHubName] <String>
      [-Query] <String>
      [-Top <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzIotHubQuery
      [-InputObject] <PSIotHub>
      [-Query] <String>
      [-Top <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzIotHubQuery
      [-ResourceId] <String>
      [-Query] <String>
      [-Top <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

強力な SQL に似た言語を使用して IoT Hub にクエリを実行し、デバイスツインとモジュールツイン、ジョブ、メッセージルーティングに関する情報を取得します。詳細については、「 https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language 」を参照してください。

例

例 1

Invoke-AzIotHubQuery -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Query "select * from devices"

Azure IoT Hub 内のすべてのデバイスツインデータに対してクエリを実行します。

例 2

Invoke-AzIotHubQuery -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Query "select * from devices.modules where devices.deviceId = 'myDevice1'" -Top 2

ターゲットデバイス上の上位 2 つのモジュールツインデータに対してクエリを実行します。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

IotHub オブジェクト

Type:	PSIotHub
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-IotHubName

IoT ハブの名前

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Query

実行するユーザークエリ。

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

リソースグループの名前

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

IotHub リソース ID

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Top

返される要素の最大数。既定では、クエリには上限はありません。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

PSIotHub

String

出力