次の方法で共有

Set-AzVMDscExtension

  • リファレンス
モジュール:
Az.Compute

仮想マシンで 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 コマンドレットによって以前にアップロードされた構成ファイルの名前を指定します。

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

-ArchiveContainerName

構成アーカイブが配置されている Azure ストレージ コンテナーの種名。

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

-ArchiveResourceGroupName

構成アーカイブを含むストレージ アカウントを含むリソース グループの名前を指定します。 ストレージ アカウントと仮想マシンの両方が同じリソース グループ内にある場合、このパラメーターは省略可能です。

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

-ArchiveStorageAccountName

ArchiveBlobName のダウンロードに使用する Azure ストレージ アカウント名を指定します。

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

-ArchiveStorageEndpointSuffix

ストレージ エンドポイントサフィックスを指定します。

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

-AutoUpdate

Version パラメーターで指定された拡張ハンドラーのバージョンを指定します。 既定では、拡張ハンドラーは自動更新されません。 AutoUpdate パラメーターを使用して、拡張機能ハンドラーを使用可能な時点で最新バージョンに自動更新できるようにします。

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

-ConfigurationArgument

構成関数の引数を含むハッシュ テーブルを指定します。

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

-ConfigurationData

構成のデータを指定する .psd1 ファイルのパスを指定します。

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

-ConfigurationName

DSC 拡張機能が呼び出す構成の名前を指定します。

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

-Confirm

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

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

-DataCollection

データ コレクションの種類を指定します。 このパラメーターに使用できる値は、Enable と Disable です。

型:String
指定可能な値:Enable, Disable
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-DefaultProfile

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

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

-Force

ユーザーの確認を求めずにコマンドを強制的に実行します。

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

-Location

リソース拡張機能のパスを指定します。

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

-Name

拡張機能を表す Azure Resource Manager リソースの名前を指定します。 既定値は Microsoft.Powershell.DSC です。

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

-NoWait

操作を開始し、操作が完了する直前に戻ります。 操作が正常に完了したかどうかを判断するには、他のメカニズムを使用します。

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

-ResourceGroupName

仮想マシンのリソース グループの名前を指定します。

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

-Version

設定を適用 Set-AzVMDscExtension DSC 拡張機能のバージョンを指定します。

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

-VMName

DSC 拡張機能ハンドラーがインストールされている仮想マシンの名前を指定します。

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

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

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

-WmfVersion

WMF バージョンを指定します。

型:String
指定可能な値:4.0, 5.0, 5.1, latest
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

入力

String

Hashtable

出力

PSAzureOperationResponse