Share via

Set-AzureVMDscExtension

  • リファレンス
モジュール:
Azure

仮想マシンで DSC 拡張機能を構成します。

注意

このドキュメントで参照されているコマンドレットは、Service Management API を使用するレガシ Azure リソースを管理するためのものです。 Azure Resource Manager リソースを管理するためのコマンドレットについては、Az PowerShell モジュールを参照してください。

構文

Set-AzureVMDscExtension
   [-ReferenceName <String>]
   [-ConfigurationArgument <Hashtable>]
   [-ConfigurationDataPath <String>]
   [-ConfigurationArchive] <String>
   [-ConfigurationName <String>]
   [-ContainerName <String>]
   [-Force]
   [-StorageContext <AzureStorageContext>]
   [-Version <String>]
   [-StorageEndpointSuffix <String>]
   [-WmfVersion <String>]
   [-DataCollection <String>]
   -VM <IPersistentVM>
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzureVMDscExtension コマンドレットは、仮想マシンで Desired State Configuration (DSC) 拡張機能を構成します。

例

例 1: 仮想マシンで DSC 拡張機能を構成する

PS C:\> Set-AzureVMDscExtension -VM $VM -ConfigurationArchive MyConfiguration.ps1.zip  -ConfigurationName MyConfiguration -ConfigurationArgument @{ Path = 'C:\MyDirectory' }
DeploymentName              : my-vm-svc
Name                        : my-vm
Label                       :
VM                          : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVM
InstanceStatus              : ReadyRole
IpAddress                   : 10.10.10.10
InstanceStateDetails        :
PowerState                  : Started
InstanceErrorCode           :
InstanceFaultDomain         : 0
InstanceName                : my-vm
InstanceUpgradeDomain       : 0
InstanceSize                : Small
AvailabilitySetName         :
DNSName                     : http://my-vm-svc.cloudapp.net/
Status                      : ReadyRole
GuestAgentStatus            : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVMModel.GuestAgentStatus
ResourceExtensionStatusList : {Contoso.Compute.BGInfo}
PublicIPAddress             :
PublicIPName                :
ServiceName                 : my-vm-svc
OperationDescription        : Get-AzureVM
OperationId                 : a0217a7af900c1f8a212299a3333cdbd6
OperationStatus             : OK

このコマンドは、仮想マシンで DSC 拡張機能を構成します。

MyConfiguration.ps1.zip パッケージは、Publish-AzureVMDscConfiguration コマンドを使用して以前に Azure Storage にアップロードされている必要があり、MyConfiguration.ps1 スクリプトと、それが依存するモジュールを含む必要があります。

MyConfiguration 引数は、実行するスクリプト内の特定の DSC 構成を示します。 -ConfigurationArgument パラメーターは、構成関数に渡される引数を持つハッシュテーブルを指定します。

例 2: 構成データへのパスを使用して仮想マシンで DSC 拡張機能を構成する

PS C:\> $VM | Set-AzureVMDscExtension -ConfigurationArchive MyConfiguration.ps1.zip  -ConfigurationName MyConfiguration -ConfigurationArgument @{ Credential = Get-Credential } -ConfigurationDataPath MyConfigurationData.psd1
DeploymentName              : my-vm-svc
Name                        : my-vm
Label                       :
VM                          : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVM
InstanceStatus              : ReadyRole
IpAddress                   : 10.10.10.10
InstanceStateDetails        :
PowerState                  : Started
InstanceErrorCode           :
InstanceFaultDomain         : 0
InstanceName                : my-vm
InstanceUpgradeDomain       : 0
InstanceSize                : Small
AvailabilitySetName         :
DNSName                     : http://my-vm-svc.cloudapp.net/
Status                      : ReadyRole
GuestAgentStatus            : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVMModel.GuestAgentStatus
ResourceExtensionStatusList : {Microsoft.Compute.BGInfo, Microsoft.Powershell.DSC}
PublicIPAddress             :
PublicIPName                :
ServiceName                 : my-vm-svc
OperationDescription        : Get-AzureVM
OperationId                 : a0217a7af900c1f8a212299a3333cdbd7
OperationStatus             : OK

このコマンドは、構成データへのパスを使用して、仮想マシン上の DSC 拡張機能を構成します。

パラメーター

-ConfigurationArchive

Publish-AzureVMDscConfiguration によって以前にアップロードされた構成パッケージ (.zip ファイル) の名前を指定します。 このパラメーターでは、パスを指定せずに、ファイルの名前のみを指定する必要があります。

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

-ConfigurationArgument

構成関数の引数を指定するハッシュテーブルを指定します。 キーは、パラメーター名とパラメーター値に対応します。

このパラメーターの有効値は、次のとおりです。

  • プリミティブ型
  • string
  • array
  • PSCredential
Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ConfigurationDataPath

構成関数のデータを指定する .psd1 ファイルのパスを指定します。 このファイルには、「構成データと環境データの分離」の説明に従ってハッシュテーブルを含める必要がありますhttps://msdn.microsoft.com/en-us/PowerShell/DSC/configData.

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

-ConfigurationName

DSC 拡張機能によって呼び出される構成スクリプトまたはモジュールの名前を指定します。

このパラメーターの値は、ConfigurationArchive にパッケージ化された スクリプトまたはモジュールに含まれる構成関数の 1 つの名前である必要があります。

このコマンドレットは、拡張子を除き、このパラメーターを省略した場合、ConfigurationArchive パラメーターによって指定されたファイルの名前に既定で設定されます。 たとえば、ConfigurationArchive が "SalesWebSite.ps1.zip" の場合、ConfigurationName の既定値は "SalesWebSite" になります。

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

-ContainerName

ConfigurationArchive が配置されている Azure ストレージ コンテナーの名前を指定します。

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

-DataCollection

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

-Force

このコマンドレットが既存の BLOB を上書きすることを示します。

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

-InformationAction

このコマンドレットが情報イベントに応答する方法を指定します。

このパラメーターの有効値は、次のとおりです。

  • 続行
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

情報変数を指定します。

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

-Profile

このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。

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

-ReferenceName

拡張機能を参照するために使用できるユーザー定義文字列を指定します。 このパラメーターは、拡張機能が初めて仮想マシンに追加されるときに指定されます。 以降の更新では、拡張機能を更新するときに、以前に使用した参照名を指定する必要があります。 拡張機能に割り当てられた ReferenceName は、Get-AzureVM コマンドレットを使用して返されます。

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

-StorageContext

構成スクリプトへのアクセスに使用するセキュリティ設定を提供する Azure ストレージ コンテキストを指定します。 このコンテキストは、ContainerName パラメーターで指定されたコンテナーへの読み取りアクセスを提供します。

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

-StorageEndpointSuffix

"core.contoso.net" など、すべてのストレージ サービスの DNS エンドポイント サフィックスを指定します。

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

-Version

使用する DSC 拡張機能の特定のバージョンを指定します。 このパラメーターが指定されていない場合、既定値は "1.*" に設定されます。

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

-VM

永続的な仮想マシン オブジェクトを指定します。

Type:IPersistentVM
Aliases:InputObject
Position:Named
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

仮想マシンにインストールする Windows Management Framework (WMF) のバージョンを指定します。 DSC 拡張機能は、WMF 更新プログラムでのみ使用できる DSC 機能に依存します。 このパラメーターは、仮想マシンにインストールする更新プログラムのバージョンを指定します。 このパラメーターの有効値は、次のとおりです。

  • 4.0. 新しいバージョンが既にインストールされていない限り、WMF 4.0 をインストールします。
  • 5.0. WMF 5.0 の最新リリースをインストールします。
  • 最新。 最新の WMF (現在 WMF 5.0) をインストールします。

既定値は latest です。

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