Set-SCCustomPropertyValue

カスタム プロパティの値を更新します。

構文

Set-SCCustomPropertyValue
   -CustomProperty <CustomProperty>
   -InputObject <ClientObject>
   -Value <String>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Set-SCCustomPropertyValue
   -CustomProperty <CustomProperty>
   -Value <String>
   -JobGroup <Guid>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

説明

Set-SCCustomPropertyValue コマンドレットは、カスタム プロパティの値を更新します。

例 1: 仮想マシンのカスタム プロパティの値を設定する

PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> $CustomProp = Get-SCCustomProperty -Name "Cost Center"
PS C:\> Set-SCCustomPropertyValue -InputObject $VM -CustomProperty $CustomProp -Value "123"

最初のコマンドは、VM01 という名前の仮想マシン オブジェクトを取得し、そのオブジェクトを $VM 変数に格納します。

2 番目のコマンドは、Cost Center という名前のカスタム プロパティ オブジェクトを取得し、そのオブジェクトを $CustomProp 変数に格納します。

最後のコマンドでは、$VM (VM01) に格納されている仮想マシンの $CustomProp (Cost Center) に格納されているカスタム プロパティの値を 123 に設定します。

パラメーター

-CustomProperty

カスタム プロパティ オブジェクトを指定します。

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

-InputObject

取得または変更する値を持つプロパティを割り当てるオブジェクトを指定します。

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

-JobGroup

同じジョブ グループ識別子を含む最後のコマンドが実行される直前に一括して実行される、一連のコマンドの識別子を指定します。

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

-JobVariable

ジョブの進行状況を追跡して、このパラメーターで示す名前の変数に保管するように指定します。

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

-OnBehalfOfUser

ユーザー名を指定します。 このコマンドレットは、このパラメーターで指定されたユーザーに代わって動作します。

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

-OnBehalfOfUserRole

ユーザー ロールを指定します。 ユーザー ロールを取得するには、 Get-SCUserRole コマンドレットを 使用します。 このコマンドレットは、このパラメーターが指定するユーザー ロールに代わって動作します。

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

-PROTipID

このアクションをトリガーしたパフォーマンスとリソースの最適化のヒント (PRO ヒント) の ID を指定します。 このパラメーターを使用すると、PRO のヒントを監査できます。

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

-RunAsynchronously

コントロールがコマンド シェルにすぐに戻るように、ジョブが非同期的に実行されることを示します。

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

-Value

オブジェクトまたはプロパティの属性を設定するために使用する文字列を指定します。

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

メモ

  • Get-SCCustomProperty コマンドレットを使用して取得できる VMM カスタム プロパティ オブジェクトが必要です。