docs: Created new .md file for reuse log analytics #1817
Conversation
NirajC-Microsoft
requested review from
Avijit-Microsoft,
Roopan-Microsoft,
Prajwal-Microsoft,
Fr4nc3 and
Vinay-Microsoft
as code owners
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR adds standalone documentation for reusing existing Azure resources during local deployment and integrates these guides into the main local deployment instructions.
- Introduces a new guide for reusing a Log Analytics workspace
- Introduces a new guide for reusing an Azure Resource Group
- Updates the LOCAL_DEPLOYMENT.md with links to the new guides
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/reuse_loganalytics.md | Adds steps to reuse an existing Log Analytics workspace (conflict markers present) |
| docs/re-use-resourcegroup.md | Adds steps to reuse an existing Resource Group |
| docs/LOCAL_DEPLOYMENT.md | Links to the new reuse guides before running azd up |
| @@ -0,0 +1,35 @@ | |||
| <<<<<<< HEAD | |||
There was a problem hiding this comment.
Unresolved Git conflict markers detected. Please remove the <<<<<<<, =======, and >>>>>>> lines and ensure the correct backlink text is retained.
Copilot uses AI. Check for mistakes.
| @@ -12,6 +12,8 @@ The easiest way to run this accelerator is in a VS Code Dev Containers, which wi | |||
| 1. In the VS Code window that opens, once the project files show up (this may take several minutes), open a terminal window | |||
| 1. Run `azd auth login` | |||
| 1. Run `azd env set AZURE_APP_SERVICE_HOSTING_MODEL code` - This sets your environment to deploy code rather than rely on public containers, like the "Deploy to Azure" button. | |||
| 1. To use an existing Log Analytics workspace, follow the [setup steps here](../docs/REUSE_LOGANALYTICS.md) before running `azd up`. | |||
There was a problem hiding this comment.
Filename in the link (REUSE_LOGANALYTICS.md) does not match the actual file name reuse_loganalytics.md (case-sensitive). Update the link to match exactly.
| 1. To use an existing Log Analytics workspace, follow the [setup steps here](../docs/REUSE_LOGANALYTICS.md) before running `azd up`. | |
| 1. To use an existing Log Analytics workspace, follow the [setup steps here](../docs/reuse_loganalytics.md) before running `azd up`. |
Copilot uses AI. Check for mistakes.
|
|
||
| ### 1. Identify the Resource Group | ||
|
|
||
| - Visit the [Azure Portal](https://portal.azure.com) and choose the Resource Group you want to reuse. |
There was a problem hiding this comment.
Remove the leading dash (-) before 'Visit'; it's inconsistent with other step formatting and may render as an unintended list item.
| - Visit the [Azure Portal](https://portal.azure.com) and choose the Resource Group you want to reuse. | |
| Visit the [Azure Portal](https://portal.azure.com) and choose the Resource Group you want to reuse. |
Copilot uses AI. Check for mistakes.
|  | ||
|
|
||
| ### 3. Copy Workspace id | ||
| In the Overview pane, Click on JSON View | ||
|
|
||
|  | ||
|
|
||
| Copy Resource ID that is your Workspace ID | ||
|
|
||
|  |
There was a problem hiding this comment.
Use a descriptive alt attribute (e.g. ![List of Log Analytics workspaces]) to improve accessibility for screen readers.
|  | |
| ### 3. Copy Workspace id | |
| In the Overview pane, Click on JSON View | |
|  | |
| Copy Resource ID that is your Workspace ID | |
|  | |
|  | |
| ### 3. Copy Workspace id | |
| In the Overview pane, Click on JSON View | |
|  | |
| Copy Resource ID that is your Workspace ID | |
|  |
Copilot uses AI. Check for mistakes.
| azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID '<Existing Log Analytics Workspace Id>' | ||
| ``` | ||
| Replace `<Existing Log Analytics Workspace Id>` with the value obtained from Step 3. |
There was a problem hiding this comment.
There are two spaces before 'obtained'; please remove the extra space. Also, standardize 'Id' to 'ID' for consistency.
| azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID '<Existing Log Analytics Workspace Id>' | |
| ``` | |
| Replace `<Existing Log Analytics Workspace Id>` with the value obtained from Step 3. | |
| azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID '<Existing Log Analytics Workspace ID>' |
Replace <Existing Log Analytics Workspace ID> with the value obtained from Step 3.
Copilot uses AI. Check for mistakes.
| @@ -0,0 +1,35 @@ | |||
| [← Back to *LOCAL_DEPLOYMENT* guide](../docs/LOCAL_DEPLOYMENT.md) | |||
There was a problem hiding this comment.
[nitpick] Consider standardizing link text across both guides (e.g., 'Back to LOCAL_DEPLOYMENT guide') to ensure consistency.
| [← Back to *LOCAL_DEPLOYMENT* guide](../docs/LOCAL_DEPLOYMENT.md) | |
| [Back to LOCAL_DEPLOYMENT guide](../docs/LOCAL_DEPLOYMENT.md) |
Copilot uses AI. Check for mistakes.
Purpose
This pull request updates the documentation to include instructions for reusing an existing Log Analytics workspace during local deployment. The changes aim to improve clarity and usability for developers setting up their environment.
Documentation Updates for Local Deployment:
Added a step to guide users on how to reuse an existing Log Analytics workspace before running
azd up. This ensures users can configure their environment appropriately if they already have a workspace.Created a new file with detailed instructions for reusing an existing Log Analytics workspace. It includes steps for navigating the Azure Portal, copying the workspace ID, setting it in the environment, and returning to the local deployment guide.
Does this introduce a breaking change?
How to Test
What to Check
Verify that the following are valid
Other Information