atlas deployments delete
删除部署。
在不使用 --force 选项的情况下运行该命令时,该命令会提示您确认操作。
删除 Atlas 部署也会删除该集群的所有备份快照。 删除本地部署也会删除所有本地数据卷。
要使用此命令,您必须使用具有项目所有者角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas deployments delete [deploymentName] [options]
参数
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
deploymentName | 字符串 | false | 要删除的部署的名称。 |
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--force | false | 指示在继续执行请求的操作之前是否跳过确认提示的标志。 | |
-h,--help | false | 删除帮助 | |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
--type | 字符串 | false | 部署类型。 有效值为 ATLAS 或 LOCAL。 |
-w, --watch | false | 该标志指示是否监视命令,直到命令完成执行或监视超时。 要设置手表超时的时间,请使用 --watchTimeout 选项。 | |
--watchTimeout | uint | false | 手表超时之前的时间(以秒为单位)。 监视超时后,CLI 将不再监视该命令。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
Deployment '<Name>' deleted
举例
# Remove an Atlas deployment named myDeployment after prompting for a confirmation: atlas deployments delete myDeployment --type ATLAS
# Remove an Atlas deployment named myDeployment without requiring confirmation: atlas deployments delete myDeployment --type ATLAS --force
# Remove an Local deployment named myDeployment without requiring confirmation: atlas deployments delete myDeployment --type LOCAL --force