Atlas 配置の削除
配置を削除します。
-- force オプションを指定せずにコマンドを実行すると、コマンドによって操作の確認を求めるメッセージが表示されます。
Atlas 配置を削除すると、そのクラスターのバックアップ スナップショットも削除されます。 ローカル配置を削除すると、すべてのローカル データ ボリュームも削除されます。
このコマンドを使用するには、プロジェクト オーナーのユーザー アカウントまたは API キーで認証する必要があります。
構文
コマンド構文
atlas deployments delete [deploymentName] [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
deploymentName | string | false | 削除する配置の名前。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- force | false | 要求されたアクションを続行する前に確認プロンプトをスキップするかどうかを示すフラグ。 | |
-h, --help | false | 削除のヘルプ | |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
--type | string | false | 配置のタイプ。 有効な値は Atlas または Local です。 |
-w, --watch | false | コマンドの実行が完了するまで監視するか、監視がタイムアウトするまで監視するかを示すフラグ。 監視がタイムアウトする時間を設定するには --watchTimeout オプションを使用します。 | |
--watchTimeout | 整数 | false | 監視がタイムアウトするまでの時間（秒単位）。 監視がタイムアウトすると、CLI は コマンドの監視を終了します。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルについては、 https://docub.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