跳至主要内容

命令:workspace delete

tofu workspace delete 命令用于删除现有的工作区。

用法

用法:tofu workspace delete [OPTIONS] NAME [DIR]

此命令将删除指定的工作区。

要删除工作区,它必须已存在,它不能跟踪资源,并且不能是您当前的工作区。如果工作区正在跟踪资源,OpenTofu 将不允许您删除它,除非指定了 -force 标志。

此外,不同的 后端 可能会对在没有 -force 标志的情况下是否将工作区视为安全删除实施其他限制,例如工作区是否被锁定。

如果您删除了一个正在跟踪资源(通过 -force)的工作区,那么资源可能会变成“悬空”状态。这些是物理上存在但 OpenTofu 无法再管理的资源。这有时是首选:您可能希望 OpenTofu 停止管理资源,以便可以通过其他方式管理它们。但是,大多数情况下,这不是预期的,因此 OpenTofu 会保护您免受陷入这种情况。

命令行标志都是可选的。唯一支持的标志是

  • -force - 即使工作区正在跟踪资源,也删除它。删除后,OpenTofu 将无法再跟踪或管理工作区的基础设施。默认为 false。

  • -lock=false - 在操作期间不要持有状态锁。如果其他人可能同时对同一工作区运行命令,这将非常危险。

  • -lock-timeout=DURATION - 重试状态锁的持续时间。默认 0 秒。

  • -var 'NAME=VALUE' - 为配置根模块中声明的单个 输入变量 设置值。多次使用此选项可设置多个变量。有关更多信息,请参阅 命令行上的输入变量

  • -var-file=FILENAME - 使用来自 "tfvars" 文件 的定义,为配置根模块中声明的可能多个 输入变量 设置值。多次使用此选项可包含来自多个文件的值。

除了 -var-var-file 选项外,还有几种其他方法可以为根模块中的输入变量设置值。有关更多信息,请参阅 为根模块变量赋值

示例

代码块
$ tofu workspace delete example
Deleted workspace "example".