diff --git a/README.md b/README.md index f4269272..c62009bb 100644 --- a/README.md +++ b/README.md @@ -15,18 +15,19 @@ - [Deploying with existing resources](#deploying-with-existing-resources) - [Deploying again](#deploying-again) - [Sharing environments](#sharing-environments) +- [Clean up](#clean-up) - [Enabling optional features](#enabling-optional-features) - [Enabling authentication](#enabling-authentication) - [Using the app](#using-the-app) -- [Running locally](#running-locally) -- [Using a different backend](#using-a-different-backend) -- [Productionizing](#productionizing) -- [Clean up](#clean-up) -- [Resources](#resources) - - [Note](#note) +- [Guidance](#guidance) + - [Running locally](#running-locally) + - [Using a different backend](#using-a-different-backend) + - [Productionizing](#productionizing) + - [Resources](#resources) - [FAQ](#faq) - [Troubleshooting](#troubleshooting) +- [Note](#note) [![Open in GitHub Codespaces](https://img.shields.io/static/v1?style=for-the-badge&label=GitHub+Codespaces&message=Open&color=brightgreen&logo=github)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=684521881&machine=standardLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestUs2) [![Open in Remote - Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Remote%20-%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/azure-samples/azure-search-openai-javascript) @@ -192,6 +193,16 @@ either you or they can follow these steps: 1. Set the environment variable `AZURE_PRINCIPAL_ID` either in that `.env` file or in the active shell to their Azure ID, which they can get with `az ad signed-in-user show`. 1. Run `./scripts/roles.ps1` or `./scripts/roles.sh` to assign all of the necessary roles to the user. If they do not have the necessary permission to create roles in the subscription, then you may need to run this script for them. Once the script runs, they should be able to run the app locally. +## Clean up + +To clean up all the resources created by this sample: + +1. Run `azd down --purge` +2. When asked if you are sure you want to continue, enter `y` +3. When asked if you want to permanently delete the resources, enter `y` + +The resource group and all the resources will be deleted. + ## Enabling optional features