Skip to content

Commit ccc6f42

Browse files
author
Shreyas-Microsoft
committed
add info regarding naming and cleanup of environments
1 parent dc50b68 commit ccc6f42

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

docs/DeploymentGuide.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -247,24 +247,33 @@ When creating your environment name, follow these rules:
247247
**Invalid names:** `cps-app`, `CPS_App`, `content-processing`, `my app`
248248
**Valid names:** `cpsapp01`, `mycontentapp`, `devtest123`
249249

250-
> **🛠️ Need help generating a compliant name?** Use our name generator script:
251-
> ```powershell
252-
> .\infra\scripts\generate-environment-name.ps1
253-
> ```
254-
> Or run interactively: `.\infra\scripts\generate-environment-name.ps1 -Interactive`
250+
> **� Tips for generating compliant names:**
251+
> - Start with a descriptive prefix like `cps`, `content`, `docproc`, `myapp`
252+
> - Add a suffix like `dev`, `test`, `prod`, or numbers `01`, `02`
253+
> - Keep it memorable and relevant to your use case
254+
> - Examples: `cpsdev01`, `contentprod`, `myapptest`, `docproc123`
255255

256256
#### **🧹 Environment Cleanup**
257257

258-
> **💡 Tip:** If you have old environments that failed deployment or are no longer needed, use our cleanup script:
258+
> **💡 Tip:** If you have old environments that failed deployment or are no longer needed:
259+
>
260+
> **To clean up azd environments:**
259261
> ```powershell
260262
> # List all environments
261-
> .\infra\scripts\cleanup-environments.ps1 -ListOnly
263+
> azd env list
262264
>
263265
> # Clean up a specific environment
264-
> .\infra\scripts\cleanup-environments.ps1 -EnvironmentName "oldenvname"
266+
> azd env select <old-environment-name>
267+
> azd down --force --purge
268+
> ```
269+
>
270+
> **To clean up Azure resource groups (if needed):**
271+
> ```powershell
272+
> # List resource groups
273+
> az group list --output table
265274
>
266-
> # Clean up environment AND Azure resource group
267-
> .\infra\scripts\cleanup-environments.ps1 -EnvironmentName "oldenvname" -DeleteResourceGroup
275+
> # Delete a specific resource group
276+
> az group delete --name <resource-group-name> --yes --no-wait
268277
> ```
269278

270279
#### **🚀 Deployment Steps**

0 commit comments

Comments
 (0)