Set-AzureVMDscExtension

參考

模組:: Azure

在虛擬機上設定 DSC 擴充功能。

注意

本文件中參考的 Cmdlet 用於管理使用 Azure Service Manager（ASM） API 的舊版 Azure 資源。建立新的資源時，不建議使用此舊版 PowerShell 模組，因為 ASM 已排定淘汰。如需詳細資訊，請參閱 Azure Service Manager 淘汰。

Az PowerShell 模組是使用 PowerShell 管理 Azure Resource Manager （ARM）資源的建議 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>]

Description

Set-AzureVMDscExtension Cmdlet 會在虛擬機上設定 Desired 狀態設定（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 記憶體，並包含 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檔案）。此參數必須只指定檔名，而不需要任何路徑。

類型:	String
Position:	1
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-ConfigurationArgument

指定哈希表，指定組態函式的自變數。索引鍵會對應至參數名稱和值至參數值。

此參數可接受的值為：

基本類型
字串
陣列
PSCredential

類型:	Hashtable
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-ConfigurationDataPath

指定 .psd1 檔案的路徑，指定組態函式的數據。此檔案必須包含哈希表，如分隔組態和環境數據中所述https://msdn.microsoft.com/en-us/PowerShell/DSC/configData.

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-ConfigurationName

指定 DSC 擴充功能所叫用的組態腳本或模組名稱。

此參數的值必須是 ConfigurationArchive 中封裝之腳本或模組中包含的其中一個組態函式名稱。

如果您省略此參數，則此 Cmdlet 預設為 ConfigurationArchive 參數所提供的檔名，但不包括任何擴展名。例如，如果 ConfigurationArchive 為 “SalesWebSite.ps1.zip”，ConfigurationName 的預設值為 “SalesWebSite”。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-Confirm

執行 Cmdlet 之前先提示您確認。

類型:	SwitchParameter
別名:	cf
Position:	Named
預設值:	False
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-ContainerName

指定 ConfigurationArchive 所在的 Azure 記憶體容器名稱。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-DataCollection

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-Force

表示此 Cmdlet 會覆寫現有的 Blob。

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-InformationAction

指定此 Cmdlet 如何回應資訊事件。

此參數可接受的值為：

繼續
忽略
詢問
SilentlyContinue
停止
暫止

類型:	ActionPreference
別名:	infa
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-InformationVariable

指定資訊變數。

類型:	String
別名:	iv
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Profile

指定此 Cmdlet 從中讀取的 Azure 設定檔。如果您未指定設定檔，此 Cmdlet 會從本機預設配置檔讀取。

類型:	AzureSMProfile
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-ReferenceName

指定可用來參考延伸模組的使用者定義字串。第一次將擴充功能新增至虛擬機時，會指定此參數。針對後續更新，您應該在更新延伸模組時指定先前使用的參考名稱。 指派給擴充功能的 ReferenceName 會使用 Get-AzureVM Cmdlet 傳回。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-StorageContext

指定 Azure 記憶體內容，提供用來存取組態腳本的安全性設定。此內容提供 ContainerName 參數所指定容器的讀取許可權。

類型:	AzureStorageContext
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-StorageEndpointSuffix

指定所有記憶體服務的 DNS 端點後綴，例如「core.contoso.net」。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-Version

指定要使用之 DSC 擴充功能的特定版本。如果未指定此參數，預設值會設定為「1.*」。。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-VM

指定持續性虛擬機物件。

類型:	IPersistentVM
別名:	InputObject
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-WhatIf

顯示執行 Cmdlet 後會發生的情況。未執行 Cmdlet。

類型:	SwitchParameter
別名:	wi
Position:	Named
預設值:	False
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-WmfVersion

指定要安裝在虛擬機上的 Windows Management Framework （WMF）版本。 DSC 擴充功能取決於只有 WMF 更新中可用的 DSC 功能。此參數會指定要在虛擬機上安裝的更新版本。此參數可接受的值為：

4.0. 除非已安裝較新版本，否則會安裝 WMF 4.0。
5.0. 安裝最新版的 WMF 5.0。
最近的。安裝最新的 WMF，目前是 WMF 5.0。

預設值為 latest。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

共用方式為

Set-AzureVMDscExtension

語法

Description

範例

範例 1：在虛擬機上設定 DSC 擴充功能

範例 2：使用設定資料的路徑在虛擬機上設定 DSC 擴充功能

參數

-ConfigurationArchive

-ConfigurationArgument

-ConfigurationDataPath

-ConfigurationName

-Confirm

-ContainerName

-DataCollection

-Force

-InformationAction

-InformationVariable

-Profile

-ReferenceName

-StorageContext

-StorageEndpointSuffix

-Version

-VM

-WhatIf

-WmfVersion

其他資源

共用方式為

Set-AzureVMDscExtension

語法

Description

範例

範例 1：在虛擬機上設定 DSC 擴充功能

範例 2：使用設定資料的路徑在虛擬機上設定 DSC 擴充功能

參數

-ConfigurationArchive

-ConfigurationArgument

-ConfigurationDataPath

-ConfigurationName

-Confirm

-ContainerName

-DataCollection

-Force

-InformationAction

-InformationVariable

-Profile

-ReferenceName

-StorageContext

-StorageEndpointSuffix

-Version

-VM

-WhatIf

-WmfVersion

相關連結

其他資源