dsc 资源删除

摘要

调用资源的删除操作。

语法

没有实例属性

dsc resource delete [Options] --resource <RESOURCE>

来自 stdin 的实例属性

<instance-properties> | dsc resource delete [Options] --resource <RESOURCE>

输入选项中的实例属性

dsc resource delete --input '<instance-properties>' --resource <RESOURCE>

文件中的实例属性

dsc resource delete --path <instance-properties-filepath> --resource <RESOURCE>

说明

子 delete 命令删除资源实例。

资源识别要删除的实例所需的任何属性都必须作为 JSON 或 YAML 对象传递给此命令。可以通过 stdin 或选项 --input 将对象传递给此命令。还可以使用 --path 选项从 JSON 或 YAML 文件中读取对象。

成功时，此命令不返回任何输出。如果遇到错误，它会将错误呈现给 stderr 上的调用方，并使用非零退出代码退出。

示例

示例 1 - 使用输入选项删除资源实例

如果资源需要一个或多个属性值才能返回实例的实际状态，则可以使用输入选项以 JSON 或 YAML 的形式传递实例属性。

dsc resource delete --resource Microsoft.Windows/Registry --input '{
    "keyPath": "HKCU\\DSC\\Example"
}'

示例 2 - 使用 stdin 中的输入删除资源实例

如果资源需要一个或多个属性值才能返回实例的实际状态，则可以将实例属性作为 JSON 或 YAML 通过 stdin 传递。

'{
    "keyPath": "HKCU\\DSC\\Example"
}' | dsc resource delete --resource Microsoft.Windows/Registry

示例 3 - 使用 YAML 文件中的输入删除资源实例

如果资源需要一个或多个属性值才能返回实例的实际状态，则可以从保存的 JSON 或 YAML 文件中检索实例属性。

cat ./example.delete.yaml

keyPath: HKCU\\DSC\\Example

dsc resource delete --resource Microsoft.Windows/Registry --path ./example.delete.yaml

选项

-r、 --resource

指定要使用的 DSC 资源的完全限定类型名称，例如 Microsoft.Windows/Registry。

完全限定的类型名称语法为： <owner>[.<group>][.<area>]/<name>，其中：

是 owner 资源的维护作者或组织。
group和 area 是可选名称组件，用于为资源启用命名空间。
标识 name 资源管理的组件。

Type:      String
Mandatory: true

-i、 --input

指定具有检索 DSC 资源实例所需的属性的 JSON 或 YAML 对象。 DSC 根据资源的实例架构验证对象。如果验证失败，DSC 将引发错误。

此选项不能与 stdin 或 --path 选项上的实例属性一起使用。选择是将实例属性通过 stdin、从具有 --path 选项的文件中传递，还是使用 --input 选项将实例属性传递给命令。

指定选项时， --all DSC 将忽略此选项。

Type:      String
Mandatory: false

-p、 --path

定义要读取为命令输入的文本文件的路径，而不是从 stdin 传递输入或使用选项将其作为字符串 --input 传递。指定的文件必须包含表示资源的有效属性的 JSON 或 YAML。 DSC 根据资源的实例架构验证对象。如果验证失败，或者指定的文件不存在，DSC 将引发错误。

此选项与 --input 选项互斥。使用此选项时，DSC 会忽略来自 stdin 的任何输入。