Remove-AzIotHubDeviceChildren

モジュール:

Az.IotHub

指定したエッジ デバイスから子として非エッジ デバイスを削除します。

構文

Remove-AzIotHubDeviceChildren
      [-ResourceGroupName] <String>
      [-IotHubName] <String>
      [-DeviceId] <String>
      [-Children <String[]>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzIotHubDeviceChildren
      [-InputObject] <PSIotHub>
      [-DeviceId] <String>
      [-Children <String[]>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzIotHubDeviceChildren
      [-ResourceId] <String>
      [-DeviceId] <String>
      [-Children <String[]>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

子指定のエッジ デバイスとして、すべてのデバイスまたは指定された非エッジ デバイスを削除します。

例

例 1

Remove-AzIotHubDeviceChildren -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Children device1,device2 -Passthru

True

指定したデバイスの子として、メンションされたデバイスを削除します。

例 2

Remove-AzIotHubDeviceChildren -ResourceGroupName "myresourcegroup" -IotHubName "myiothub" -DeviceId "myDevice1" -Passthru

True

すべての非エッジ デバイスを子指定のエッジ デバイスとして削除します。

パラメーター

-Children

子デバイスの一覧 (コンマ区切り) には、エッジ以外のデバイスのみが含まれます。

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

-Confirm

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

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

-DefaultProfile

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

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

-DeviceId

エッジ デバイスの ID。

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

-InputObject

IotHub オブジェクト

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

-IotHubName

IoT ハブの名前

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

-PassThru

ブール値オブジェクトを返すことができます。 既定では、このコマンドレットによる出力はありません。

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

-ResourceGroupName

リソース グループの名前

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

-ResourceId

IotHub リソース ID

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

-WhatIf

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

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

入力

PSIotHub

String

出力

Boolean