你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 cmdlet 在资源组中的虚拟机上配置 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 的配置。 以前使用 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 的配置，并指定配置数据和参数。 此命令还允许将扩展处理程序自动更新到最新版本。 Sample.ps1.zip以前是使用 Publish-AzVMDscConfiguration 上传的。

参数

-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 资源管理器 资源的名称。 默认值为 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