Add-AzIotHubConfiguration

在目標 IoT 中樞 中加入 IoT 自動裝置管理設定。

語法

ResourceSet (預設值)

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

InputObjectSet

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

ResourceIdSet

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

Description

設定內容為 json,並根據裝置或模組意圖而略有不同。 裝置組態的格式為 {“deviceContent”:{...}} 模組組態的格式為 {“moduleContent”:{...}} 您可以使用使用者提供的計量來定義組態,以進行隨選評估。 用戶計量為 json,格式為 {“query”:{...}} 或 {“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'"

建立優先順序為 3 的裝置組態,該組態會在裝置在建築物 9 中標記且環境為「測試」時套用條件。

範例 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

在執行 Cmdlet 之前,提示您進行確認。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:CF

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DefaultProfile

用於與 Azure 通訊的憑證、帳號、租戶和訂閱。

參數屬性

類型:IAzureContextContainer
預設值:None
支援萬用字元:False
不要顯示:False
別名:AzContext, AzureRmContext, AzureCredential

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DeviceContent

IotHub 裝置的設定。

參數屬性

類型:Hashtable
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-InputObject

IotHub 物件

參數屬性

類型:PSIotHub
預設值:None
支援萬用字元:False
不要顯示:False

參數集

InputObjectSet
Position:0
必要:True
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-IotHubName

IoT 中樞的名稱

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ResourceSet
Position:1
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Label

要套用至目標組態的標籤對應。

參數屬性

類型:Hashtable
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Metric

組態計量定義的查詢集合。

參數屬性

類型:Hashtable
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Name

組態的識別碼。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Priority

在競爭規則(最高獲勝)的情況下,裝置組態的權數。

參數屬性

類型:Int32
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ResourceGroupName

資源群組的名稱

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ResourceSet
Position:0
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ResourceId

IotHub 資源識別碼

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ResourceIdSet
Position:0
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-TargetCondition

裝置組態適用的目標條件。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 指令未執行。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False
別名:WI

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援常見參數: -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。

輸入

PSIotHub

String

輸出

PSConfiguration