New-AzConnectedMachineExtension

モジュール:

Az.ConnectedMachine

拡張機能を作成または更新する操作。

構文

New-AzConnectedMachineExtension
   -MachineName <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -Location <String>
   [-AutoUpgradeMinorVersion]
   [-EnableAutomaticUpgrade]
   [-ExtensionType <String>]
   [-ForceRerun <String>]
   [-InstanceViewName <String>]
   [-InstanceViewType <String>]
   [-InstanceViewTypeHandlerVersion <String>]
   [-ProtectedSetting <Hashtable>]
   [-Publisher <String>]
   [-Setting <Hashtable>]
   [-StatusCode <String>]
   [-StatusDisplayStatus <String>]
   [-StatusLevel <String>]
   [-StatusMessage <String>]
   [-StatusTime <DateTime>]
   [-Tag <Hashtable>]
   [-TypeHandlerVersion <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzConnectedMachineExtension
   -MachineName <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -JsonString <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzConnectedMachineExtension
   -MachineName <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -JsonFilePath <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzConnectedMachineExtension
   -MachineName <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -ExtensionParameter <IMachineExtension>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzConnectedMachineExtension
   -Name <String>
   -MachineInputObject <IConnectedMachineIdentity>
   -Location <String>
   [-AutoUpgradeMinorVersion]
   [-EnableAutomaticUpgrade]
   [-ExtensionType <String>]
   [-ForceRerun <String>]
   [-InstanceViewName <String>]
   [-InstanceViewType <String>]
   [-InstanceViewTypeHandlerVersion <String>]
   [-ProtectedSetting <Hashtable>]
   [-Publisher <String>]
   [-Setting <Hashtable>]
   [-StatusCode <String>]
   [-StatusDisplayStatus <String>]
   [-StatusLevel <String>]
   [-StatusMessage <String>]
   [-StatusTime <DateTime>]
   [-Tag <Hashtable>]
   [-TypeHandlerVersion <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzConnectedMachineExtension
   -Name <String>
   -MachineInputObject <IConnectedMachineIdentity>
   -ExtensionParameter <IMachineExtension>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzConnectedMachineExtension
   -InputObject <IConnectedMachineIdentity>
   -Location <String>
   [-AutoUpgradeMinorVersion]
   [-EnableAutomaticUpgrade]
   [-ExtensionType <String>]
   [-ForceRerun <String>]
   [-InstanceViewName <String>]
   [-InstanceViewType <String>]
   [-InstanceViewTypeHandlerVersion <String>]
   [-ProtectedSetting <Hashtable>]
   [-Publisher <String>]
   [-Setting <Hashtable>]
   [-StatusCode <String>]
   [-StatusDisplayStatus <String>]
   [-StatusLevel <String>]
   [-StatusMessage <String>]
   [-StatusTime <DateTime>]
   [-Tag <Hashtable>]
   [-TypeHandlerVersion <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzConnectedMachineExtension
   -InputObject <IConnectedMachineIdentity>
   -ExtensionParameter <IMachineExtension>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

拡張機能を作成または更新する操作。

例

例 1: マシンに新しい拡張機能を追加する

$Settings = @{ "commandToExecute" = "powershell.exe -c Get-Process" }
New-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName win-eastus1 -Location eastus -Publisher "Microsoft.Compute" -TypeHandlerVersion 1.10 -Settings $Settings -ExtensionType CustomScriptExtension

Name   Location ProvisioningState
----   -------- -----------------
custom eastus   Succeeded

マシンの拡張機能を設定します。

例 2: パイプラインで指定された拡張パラメーターを持つ新しい拡張機能を追加する

$otherExtension = Get-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName other
$otherExtension | New-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName important

Name   Location ProvisioningState
----   -------- -----------------
custom eastus   Succeeded

これにより、パイプライン経由で渡されたオブジェクトによって提供される拡張パラメーターを使用して、新しい拡張機能が作成されます。 これは、あるマシンのパラメーターを取得して別のマシンに適用する場合に最適です。

例 3: パイプラインで指定された場所を持つ新しい拡張機能を追加する

$identity = [Microsoft.Azure.PowerShell.Cmdlets.ConnectedMachine.Models.ConnectedMachineIdentity]@{
    Id = "/subscriptions/$($SubscriptionId)/resourceGroups/$($ResourceGroupName)/providers/Microsoft.HybridCompute/machines/$MachineName/extensions/$ExtensionName"
}
$Settings = @{ "commandToExecute" = "powershell.exe -c Get-Process" }
$identity | New-AzConnectedMachineExtension -Location eastus -Publisher "Microsoft.Compute" -TypeHandlerVersion 1.10 -Settings $Settings -ExtensionType CustomScriptExtension

Name   Location ProvisioningState
----   -------- -----------------
custom eastus   Succeeded

これにより、パイプライン経由で提供される ID を使用して、新しいマシン拡張機能が作成されます。 これは行わない可能性がありますが、可能です。

例 4: 更新の場所とパラメーターの両方として拡張オブジェクトを使用して新しい拡張機能を追加する

$ext = Get-AzConnectedMachineExtension -Name custom -ResourceGroupName ContosoTest -MachineName other
$ext | New-AzConnectedMachineExtension -ExtensionParameter $ext

これにより、パイプラインで提供される ID と、渡された拡張オブジェクトによって提供される拡張機能の詳細を使用して、新しいマシン拡張機能が作成されます。 これは行わない可能性がありますが、可能です。

パラメーター

-AsJob

コマンドをジョブとして実行する

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

-AutoUpgradeMinorVersion

展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。

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

-Confirm

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

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

-DefaultProfile

DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableAutomaticUpgrade

使用可能な新しいバージョンがある場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。

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

-ExtensionParameter

マシン拡張機能について説明します。

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

-ExtensionType

拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。

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

-ForceRerun

拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。

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

-InputObject

IDENTITY パラメーター

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

-InstanceViewName

コンピューター拡張機能の名前。

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

-InstanceViewType

拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。

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

-InstanceViewTypeHandlerVersion

スクリプト ハンドラーのバージョンを指定します。

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

-JsonFilePath

作成操作に指定された Json ファイルのパス

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

-JsonString

作成操作に指定された Json 文字列

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

-Location

リソースが存在する地理的な場所

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

-MachineInputObject

IDENTITY パラメーター

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

-MachineName

拡張機能を作成または更新するコンピューターの名前。

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

-NoWait

コマンドを非同期的に実行する

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

-ProtectedSetting

拡張機能には、protected設定 または protected設定FromKeyVault、または保護された設定をまったく含めなくなります。

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

-Publisher

拡張ハンドラーの発行元の名前。

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

-ResourceGroupName

リソース グループの名前。 名前の大文字と小文字は区別されます。

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

-Setting

拡張機能の Json 形式のパブリック設定。

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

-StatusCode

状態コード。

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

-StatusDisplayStatus

状態の短いローカライズ可能なラベル。

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

-StatusLevel

レベル コード。

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

-StatusMessage

アラートやエラー メッセージを含む詳細なステータス メッセージ。

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

-StatusTime

状態の時刻。

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

-SubscriptionId

ターゲット サブスクリプションの ID。

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

リソース タグ。

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

-TypeHandlerVersion

スクリプト ハンドラーのバージョンを指定します。

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

入力

IConnectedMachineIdentity

IMachineExtension

出力

IMachineExtension