Set-AzVMDscExtension

  • 參考
模組:
Az.Compute

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

Syntax

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>]

Description

Set-AzVMDscExtension Cmdlet 會在資源群組中的虛擬機上設定 Windows PowerShell Desired 狀態設定 （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 的組態。 先前已使用 Publish-AzVMDscConfiguration 上傳Sample.ps1.zip檔案。

範例 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 的組態命令，並指定組態數據和自變數。 先前已使用 Publish-AzVMDscConfiguration 上傳Sample.ps1.zip檔案。

範例 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 的組態，並指定組態數據和自變數。 此命令也會讓擴充處理程序自動更新至最新版本。 先前已使用 Publish-AzVMDscConfiguration 上傳Sample.ps1.zip。

參數

-ArchiveBlobName

指定先前由 Publish-AzVMDscConfiguration Cmdlet 上傳的組態檔名稱。

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

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

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

-DataCollection

指定數據收集類型。 此參數可接受的值為：啟用和停用。

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

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

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

輸入

String

Hashtable

輸出

PSAzureOperationResponse