Exclua uma implantação.
O comando solicita que você confirme a operação quando executar o comando sem a opção --force.
Deleting an Atlas deployment also deletes any backup snapshots for that cluster. Deleting a Local deployment also deletes any local data volumes. Deleting a deployment will not remove saved connections from MongoDB for VS Code. This must be done manually. To learn more, see https://www.mongodb.com/pt-br/docs/mongodb-vscode/connect/#remove-a-connection.
Para usar esse comando, você deve se autenticar com uma conta de usuário, uma conta de serviço ou uma chave de API com a role Proprietário do projeto.
Sintaxe
atlas deployments delete [deploymentName] [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
deploymentName | string | false | Nome do sistema que você deseja excluir. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--force | false | Sinalizador que indica se o prompt de confirmação deve ser ignorado antes de prosseguir com a ação solicitada. | |
-h, --help | false | ajuda para excluir | |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
--type | string | false | Tipo de implementação. Os valores válidos são Atlas ou Local. |
-w, --watch | false | Sinalizador que indica se o comando deve ser observado até que ele conclua a execução ou o aviso expire. Para definir o tempo limite do relógio, use a opção --watchTimeout. | |
--watchTimeout | int | false | Tempo em segundos até que um relógio expire. Após o tempo limite de observação, a CLI não observa mais o comando. |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
Deployment '<Name>' deleted
Exemplos
# 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