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

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

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

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

IotHub オブジェクト

型:	PSIotHub
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-IotHubName

IoT ハブの名前

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Query

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

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソースグループの名前

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceId

IotHub リソース ID

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Top

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

型:	Int32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSIotHub

String

出力