Skip to content

docs: Document update #298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 4, 2025
Merged

docs: Document update #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
beffa99
Add files via upload
Thanusree-Microsoft Jul 1, 2025
dfcfd92
Create example.md
Thanusree-Microsoft Jul 1, 2025
eefe6a0
Add files via upload
Thanusree-Microsoft Jul 1, 2025
76f2b16
Update DeploymentGuide.md
Thanusree-Microsoft Jul 1, 2025
c3017f9
Delete docs/images/re_use_log/example.md
Thanusree-Microsoft Jul 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/DeploymentGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,14 @@ To adjust quota settings, follow these [steps](./AzureGPTQuotaSettings.md).

</details>

<details>

<summary><b>Reusing an Existing Log Analytics Workspace</b></summary>

Guide to get your [Existing Workspace ID](/docs/re-use-log-analytics.md)

</details>

### Deploying with AZD

Once you've opened the project in [Codespaces](#github-codespaces), [Dev Containers](#vs-code-dev-containers), or [locally](#local-environment), you can deploy it to Azure by following these steps:
Expand Down
Binary file added docs/images/re_use_log/logAnalytics.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/re_use_log/logAnalyticsJson.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/re_use_log/logAnalyticsList.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions docs/re-use-log-analytics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[← Back to *DEPLOYMENT* guide](https://github.com/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator/blob/psl-reuselog-file/docs/DeploymentGuide.md#deployment-options--steps)

# Reusing an Existing Log Analytics Workspace
To configure your environment to use an existing Log Analytics Workspace, follow these steps:
---
### 1. Go to Azure Portal
Go to https://portal.azure.com

### 2. Search for Log Analytics
In the search bar at the top, type "Log Analytics workspaces" and click on it and click on the workspace you want to use.

![alt text](../docs/images/re_use_log/logAnalyticsList.png)

### 3. Copy Resource ID
In the Overview pane, Click on JSON View

![alt text](../docs/images/re_use_log/logAnalytics.png)
Copy link

Copilot AI Jul 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The image path appears incorrect; update to images/re_use_log/logAnalytics.png to correctly reference the screenshot under docs/images.

Suggested change
![alt text](../docs/images/re_use_log/logAnalytics.png)
![alt text](images/re_use_log/logAnalytics.png)

Copilot uses AI. Check for mistakes.

Copy Resource ID that is your Workspace ID

![alt text](../docs/images/re_use_log/logAnalyticsJson.png)
Comment on lines +12 to +21
Copy link

Copilot AI Jul 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The image path appears incorrect; since this markdown file lives in docs/, update the path to images/re_use_log/logAnalyticsList.png (remove the leading ../docs/).

Suggested change
![alt text](../docs/images/re_use_log/logAnalyticsList.png)
### 3. Copy Resource ID
In the Overview pane, Click on JSON View
![alt text](../docs/images/re_use_log/logAnalytics.png)
Copy Resource ID that is your Workspace ID
![alt text](../docs/images/re_use_log/logAnalyticsJson.png)
![alt text](images/re_use_log/logAnalyticsList.png)
### 3. Copy Resource ID
In the Overview pane, Click on JSON View
![alt text](images/re_use_log/logAnalytics.png)
Copy Resource ID that is your Workspace ID
![alt text](images/re_use_log/logAnalyticsJson.png)

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Jul 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The image path appears incorrect; update to images/re_use_log/logAnalyticsJson.png so it resolves correctly.

Suggested change
![alt text](../docs/images/re_use_log/logAnalyticsJson.png)
![alt text](images/re_use_log/logAnalyticsJson.png)

Copilot uses AI. Check for mistakes.
Comment on lines +12 to +21
Copy link

Copilot AI Jul 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace the generic alt text with descriptive alt text (e.g., Log Analytics workspaces list view) and apply similarly to the other image references.

Suggested change
![alt text](../docs/images/re_use_log/logAnalyticsList.png)
### 3. Copy Resource ID
In the Overview pane, Click on JSON View
![alt text](../docs/images/re_use_log/logAnalytics.png)
Copy Resource ID that is your Workspace ID
![alt text](../docs/images/re_use_log/logAnalyticsJson.png)
![Log Analytics workspaces list view](../docs/images/re_use_log/logAnalyticsList.png)
### 3. Copy Resource ID
In the Overview pane, Click on JSON View
![Log Analytics workspace overview pane](../docs/images/re_use_log/logAnalytics.png)
Copy Resource ID that is your Workspace ID
![Log Analytics workspace JSON view with Resource ID](../docs/images/re_use_log/logAnalyticsJson.png)

Copilot uses AI. Check for mistakes.

### 4. Set the Workspace ID in Your Environment
Run the following command in your terminal
```bash
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.

### 5. Continue Deployment
Proceed with the next steps in the [deployment guide](https://github.com/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator/blob/psl-reuselog-file/docs/DeploymentGuide.md#deployment-options--steps).
Loading