Remove-DscConfigurationDocument
从 DSC 配置存储中删除配置文档。
语法
Default （默认值）
Remove-DscConfigurationDocument
-Stage <Stage>
[-Force]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
Remove-DscConfigurationDocument cmdlet 从 Windows PowerShell Desired State Configuration （DSC） 配置存储中删除配置文档（.mof 文件）。 在配置过程中，Start-DscConfiguration cmdlet 将 .mof 文件复制到目标计算机上的文件夹。 此 cmdlet 删除该配置文档并执行其他清理。
此 cmdlet 仅作为 Windows RT 8.1、Windows 8.1 和 Windows Server 2012 R2 2014 年 11 月更新汇总的一部分提供。
示例
示例 1：删除当前配置文档
$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Remove-DscConfigurationDocument -Stage Current -CimSession $Session
第一个命令使用 New-CimSession cmdlet 创建 CIM 会话，然后将 CimSession 对象存储在$Session变量中。 该命令会提示输入密码。 要了解详情，请键入 Get-Help New-CimSession。
第二个命令删除存储在 $Session 中的 CimSession 中指定的计算机的当前配置文档。
参数
-AsJob
指示此 cmdlet 以后台作业的形式运行命令。
如果指定 AsJob 参数，该命令将返回一个代表作业的对象，然后显示命令提示符。 可以在会话中继续工作，直到作业完成。
作业在本地计算机上创建，远程计算机的结果会自动返回到本地计算机。 若要管理作业，请使用作业 cmdlet。 若要获取作业结果，请使用 Receive-Job cmdlet。
若要使用此参数，必须为本地和远程计算机配置远程处理，并且必须在 Windows Vista 及更高版本的 Windows 操作系统上打开 Windows PowerShell，并使用“以管理员身份运行”选项打开 Windows PowerShell。 有关详细信息，请参阅 about_Remote_Requirements。
有关 Windows PowerShell 后台作业的详细信息，请参阅 about_Jobs 和 about_Remote_Jobs。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-CimSession
在远程会话或远程计算机上运行 cmdlet。 输入计算机名或会话对象，例如 New-CimSession 或 Get-CimSession cmdlet 的输出。
参数属性
| 类型: | |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | 会话 |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Confirm
在运行 cmdlet 之前，提示你进行确认。
参数属性
| 类型: | SwitchParameter |
| 默认值: | False |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | cf |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Force
指示此 cmdlet 在删除配置文档之前停止正在运行的配置作业。 强制命令运行而不要求用户确认。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Stage
指定要删除的配置文档。 可以指定多个文档。 此参数的可接受值为：
-
Current- 删除描述系统当前状态的配置文档。 -
Pending- 删除描述系统挂起状态的配置文档。 -
Previous- 删除描述系统先前状态的配置文档。
参数属性
| 类型: | Microsoft.PowerShell.Cmdletization.GeneratedTypes.RemoveDscConfigurationDocument.Stage |
| 默认值: | None |
| 接受的值: | Current, Pending, Previous |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-ThrottleLimit
指定可以建立以运行 cmdlet 的最大并发操作数。 如果省略此参数或输入 0 值，则 Windows PowerShell 会根据计算机上运行的 CIM cmdlet 数计算 cmdlet 的最佳限制。 限制限制仅适用于当前 cmdlet，不适用于会话或计算机。
参数属性
| 类型: | Int32 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-WhatIf
显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。
参数属性
| 类型: | SwitchParameter |
| 默认值: | False |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | 无线 |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。
