Set-AzVMDscExtension
仮想マシンで DSC 拡張機能を構成します。
構文
Set-AzVMDscExtension
[-ResourceGroupName] <String>
[-VMName] <String>
[-Name <String>]
[-ArchiveBlobName] <String>
[-ArchiveStorageAccountName] <String>
[-ArchiveResourceGroupName <String>]
[-ArchiveStorageEndpointSuffix <String>]
[-ArchiveContainerName <String>]
[-ConfigurationName <String>]
[-ConfigurationArgument <Hashtable>]
[-ConfigurationData <String>]
[-Version] <String>
[-Force]
[-Location <String>]
[-AutoUpdate]
[-WmfVersion <String>]
[-DataCollection <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Set-AzVMDscExtension コマンドレットは、リソース グループ内の仮想マシンに Windows PowerShell Desired State Configuration (DSC) 拡張機能を構成します。
例
例 1: DSC 拡張機能を設定する
Set-AzVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -Version "1.10" -Location "West US"このコマンドは、VM07 という名前の仮想マシン上の DSC 拡張機能を設定し、Stg という名前のストレージ アカウントと既定のコンテナーからSample.ps1.zipをダウンロードします。 このコマンドは、ConfigName という名前の構成を呼び出します。 Sample.ps1.zip ファイルは、Publish-AzVMDscConfiguration を使用して以前にアップロードされました。
例 2: 構成データを使用して DSC 拡張機能を設定する
Set-AzVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM13" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName "WindowsPowerShellDSC" -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US"このコマンドは、VM13 という名前の仮想マシン上の拡張機能を設定し、Stg という名前のストレージ アカウントと WindowsPowerShellDSC という名前のコンテナーからSample.ps1.zipをダウンロードします。 コマンドは ConfigName という名前の構成で、構成データと引数を指定します。 Sample.ps1.zip ファイルは、Publish-AzVMDscConfiguration を使用して以前にアップロードされました。
例 3: 自動更新を含む構成データを使用して DSC 拡張機能を設定する
Set-AzVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM22" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName WindowsPowerShellDSC -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US" -AutoUpdateこのコマンドは、VM22 という名前の仮想マシンに拡張機能を設定し、Stg という名前のストレージ アカウントと WindowsPowerShellDSC という名前のコンテナーからSample.ps1.zipをダウンロードします。 このコマンドは、ConfigName という名前の構成を呼び出し、構成データと引数を指定します。 このコマンドでは、拡張機能ハンドラーを最新バージョンに自動更新することもできます。 Sample.ps1.zipは、Publish-AzVMDscConfiguration を使用して以前にアップロードされました。
パラメーター
-ArchiveBlobName
Publish-AzVMDscConfiguration コマンドレットによって以前にアップロードされた構成ファイルの名前を指定します。
| Type: | String |
| Aliases: | ConfigurationArchiveBlob |
| Position: | 5 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ArchiveContainerName
構成アーカイブが配置されている Azure ストレージ コンテナーの種名。
| Type: | String |
| Aliases: | ContainerName |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ArchiveResourceGroupName
構成アーカイブを含むストレージ アカウントを含むリソース グループの名前を指定します。 ストレージ アカウントと仮想マシンの両方が同じリソース グループ内にある場合、このパラメーターは省略可能です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ArchiveStorageAccountName
ArchiveBlobName のダウンロードに使用する Azure ストレージ アカウント名を指定します。
| Type: | String |
| Aliases: | StorageAccountName |
| Position: | 4 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ArchiveStorageEndpointSuffix
ストレージ エンドポイントサフィックスを指定します。
| Type: | String |
| Aliases: | StorageEndpointSuffix |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AutoUpdate
Version パラメーターで指定された拡張ハンドラーのバージョンを指定します。 既定では、拡張ハンドラーは自動更新されません。 AutoUpdate パラメーターを使用して、拡張機能ハンドラーを使用可能な時点で最新バージョンに自動更新できるようにします。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConfigurationArgument
構成関数の引数を含むハッシュ テーブルを指定します。
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ConfigurationData
構成のデータを指定する .psd1 ファイルのパスを指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ConfigurationName
DSC 拡張機能が呼び出す構成の名前を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DataCollection
データ コレクションの種類を指定します。 このパラメーターに使用できる値は、Enable と Disable です。
| Type: | String |
| Accepted values: | Enable, Disable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
-Force
ユーザーに確認せずに、直ちにコマンドを実行します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
リソース拡張機能のパスを指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
拡張機能を表す Azure Resource Manager リソースの名前を指定します。 既定値は Microsoft.Powershell.DSC です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NoWait
操作を開始し、操作が完了する直前に戻ります。 操作が正常に完了したかどうかを判断するには、他のメカニズムを使用します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
仮想マシンのリソース グループの名前を指定します。
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Version
Set-AzVMDscExtension が設定を適用する DSC 拡張機能のバージョンを指定します。
| Type: | String |
| Aliases: | HandlerVersion |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMName
DSC 拡張機能ハンドラーがインストールされている仮想マシンの名前を指定します。
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WmfVersion
WMF バージョンを指定します。
| Type: | String |
| Accepted values: | 4.0, 5.0, 5.1, latest |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
入力
出力
関連リンク
Azure PowerShell
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示