Add-AzIotHubConfiguration

リファレンス

モジュール:: Az.IotHub

ターゲット IoT Hub に IoT 自動デバイス管理構成を追加します。

構文

Add-AzIotHubConfiguration
   [-ResourceGroupName] <String>
   [-IotHubName] <String>
   -Name <String>
   [-DeviceContent <Hashtable>]
   [-Priority <Int32>]
   [-TargetCondition <String>]
   [-Metric <Hashtable>]
   [-Label <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-AzIotHubConfiguration
   [-InputObject] <PSIotHub>
   -Name <String>
   [-DeviceContent <Hashtable>]
   [-Priority <Int32>]
   [-TargetCondition <String>]
   [-Metric <Hashtable>]
   [-Label <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-AzIotHubConfiguration
   [-ResourceId] <String>
   -Name <String>
   [-DeviceContent <Hashtable>]
   [-Priority <Int32>]
   [-TargetCondition <String>]
   [-Metric <Hashtable>]
   [-Label <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

構成コンテンツは json であり、デバイスまたはモジュールの意図によって若干異なります。デバイス構成は {"deviceContent":{...}} の形式です。モジュール構成は{"moduleContent":{...}} の形式です。構成は、オンデマンド評価用のユーザー指定のメトリックで定義できます。ユーザーメトリックは json であり、{"queries":{...}} の形式です。または {"metrics":{"queries":{...}}}。

注: モジュールのターゲット条件は、"from devices.modules where" で始まる必要があります。詳細については、「 https://learn.microsoft.com/azure/iot-hub/iot-hub-automatic-device-management 」を参照してください。

例

例 1

Add-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1"

既定のメタデータを使用してデバイス構成を作成します。

例 2

Add-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1" -Priority 3 -TargetCondition "tags.building=9 and tags.environment='test'"

ビルド 9 でデバイスがタグ付けされ、環境が "テスト" である場合に条件に適用される、優先順位 3 のデバイス構成を作成します。

例 3

$metrics = @{}
$metrics.add("query1", "select deviceId from devices where tags.location='US'")
Add-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1" -Metric $metrics

ユーザーメトリックを使用してデバイス構成を作成します。

例 4

$labels = @{}
$labels.add("key0","value0")
$labels.add("key1","value1")
Add-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1" -Label $labels

ラベルを含むデバイス構成を作成します。

例 5

$prop = @{}
$prop.add("Location", "US")
$content = @{}
$content.add("properties.desired.Region", $prop)
Add-AzIotHubConfiguration -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -Name "config1" -DeviceContent $content

コンテンツを含むデバイス構成を作成します。

パラメーター

-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

-DeviceContent

IotHub デバイスの構成。

Type:	Hashtable
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

-Label

ターゲット構成に適用するラベルのマップ。

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

-Metric

構成メトリック定義のクエリコレクション。

Type:	Hashtable
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

-Priority

競合するルール (最高の勝利) の場合のデバイス構成の重み。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
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

-TargetCondition

デバイス構成が適用されるターゲット条件。

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

出力

PSConfiguration