Invoke-AzIotHubConfigurationMetricsQuery

リファレンス

モジュール:: Az.IotHub

IoT デバイス構成メトリッククエリを呼び出します。

構文

Invoke-AzIotHubConfigurationMetricsQuery
      [-ResourceGroupName] <String>
      [-IotHubName] <String>
      -Name <String>
      -MetricName <String>
      [-MetricType <PSConfigurationMetricType>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzIotHubConfigurationMetricsQuery
      [-InputObject] <PSIotHub>
      -Name <String>
      -MetricName <String>
      [-MetricType <PSConfigurationMetricType>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzIotHubConfigurationMetricsQuery
      [-ResourceId] <String>
      -Name <String>
      -MetricName <String>
      [-MetricType <PSConfigurationMetricType>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

IoT デバイス構成で定義されているターゲットカスタムメトリックまたはシステムメトリックを評価します。 Iot Hub によって計算され、カスタマイズできない定義済みのシステムメトリックがあります。

"Targeted" は、ターゲット条件に一致するデバイスツインの数を指定します。
"適用済み" は、構成によって変更されたデバイスツインの数を指定しました。

例

例 1

Invoke-AzIotHubConfigurationMetricsQuery -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "myConfig1" -MetricName "warningLimit"

カスタム定義の 'warningLimit' メトリックを評価します。

例 2

Invoke-AzIotHubConfigurationMetricsQuery -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "myConfig1" -MetricName "applied" -MetricType "system"

システムの "適用済み" メトリックを評価します。

パラメーター

-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

-MetricName

評価のターゲットメトリック。

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

-MetricType

メトリックの検索に使用するメトリックコレクションを示します。

Type:	PSConfigurationMetricType
Accepted values:	Custom, System
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

構成の識別子。

Type:	String
Position:	Named
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

-WhatIf

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

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

入力

PSIotHub

String

出力

PSConfigurationMetricsResult