Skip to content

Commit 0c012df

Browse files
Hou Chi ChanCopilot
andcommitted
docs: clarify setup IDs and improve illustrated monitoring steps
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 1556a04 commit 0c012df

9 files changed

Lines changed: 45 additions & 6 deletions

‎README.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,8 @@ approved procedure is unavailable, **stop here** and follow the
2525
In Security Store, open **Private solutions** and select the subscription approved for your
2626
deployment. Review the phone-provider offers available to that subscription.
2727

28-
![Cropped examples of phone-provider offer cards in Microsoft Security Store](docs/images/onboarding/security-store-providers.png)
29-
30-
*These are cropped sample cards from Security Store, not recommendations or a complete provider
31-
list. Offers, preview labels, pricing, and access can change. A store listing does not mean the
32-
setup script supports that integration; check [guided provider support](docs/ONBOARDING.md#provider-credential-names).*
28+
See [sample offers and access guidance](docs/ONBOARDING.md#before-purchasing-or-deploying) in the
29+
detailed guide. A store listing does not mean the setup script supports that integration.
3330

3431
Have these ready:
3532

@@ -69,6 +66,13 @@ In the customer tenant's **Microsoft Entra admin center > App registrations > Ne
6966
*Some portal versions label the account type **Single tenant only**. Choose your own directory.
7067
The example above is an unsaved form, not an application you can reuse.*
7168

69+
On the registered application's **Overview**, copy these two values privately:
70+
71+
![App registration Overview with Application client ID and Directory tenant ID identified for setup and Object ID marked DO NOT USE](docs/images/onboarding/app-registration-overview.png)
72+
73+
*Use **Application (client) ID** for `ApplicationId` and **Directory (tenant) ID** for `TenantId`.
74+
The **Object ID** is not either of these setup inputs. All ID values are hidden in this example.*
75+
7276
Do not add a client secret, API permission, or app role yourself; setup handles the remaining
7377
configuration. See [application registration details](setup/docs/README.md#step-1---manually-create-the-application).
7478

@@ -112,7 +116,7 @@ See [hosting plan details](setup/docs/README.md#service-plan-selection).
112116
The **Global/EU** prompt is a provider route label, not your Azure region or a data-residency guarantee.
113117
For the resource prefix, use 2-8 lowercase letters or digits, starting with a letter.
114118

115-
![Actual setup choices for channel, provider route, provider, language, and hosting plan, with provider names hidden](docs/images/onboarding/setup-choices.png)
119+
![Cropped setup choices for provider route, provider, language, and hosting plan, with provider names hidden](docs/images/onboarding/setup-choices.png)
116120

117121
*Choose the options approved for your deployment; do not copy the example selection numbers.
118122
The Global/EU choice is not the Azure region. The hosting-plan warning applies even when a

‎docs/MONITORING.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,35 @@ necessary resource/workspace access; saving a Workbook does not grant its reader
9292
access to its data. Cross-workspace alert evaluation also needs access to each
9393
workspace under the rule's configured identity.
9494

95+
### Run a first query and read the results
96+
97+
1. In your workspace's **Logs**, close any welcome or Queries hub dialog. If the portal opens
98+
in **Agent** mode, switch it off for this walkthrough, then choose **KQL mode**.
99+
2. Paste the query below. Replace `<function-role-name>` with the `AppRoleName` you verified
100+
using the discovery query above. If a workspace contains multiple Application Insights
101+
components with that same role name, also filter by your component's `_ResourceId`.
102+
3. Select **Run**, then read the **Results** grid. Adjust `ago(48h)` to include the time of
103+
your authorized test; this query sets its own time range.
104+
105+
```kusto
106+
AppRequests
107+
| where TimeGenerated >= ago(48h)
108+
| where AppRoleName == "<function-role-name>" and Name == "SendOtp"
109+
| summarize StoredRows = count() by ResultCode, Success
110+
| order by ResultCode asc
111+
```
112+
113+
![Workspace Logs in KQL mode with a scoped request-status query, Run button, and one aggregate result row](images/onboarding/logs-query-results.png)
114+
115+
*This real query returned 11 stored rows with result code 200 and `Success=true` in the example
116+
window. The role and workspace names are hidden. The query shows counts only: no phone numbers,
117+
message bodies, credentials, or raw trace messages. Your result counts will differ.*
118+
119+
`StoredRows` counts stored telemetry records, not delivered messages or necessarily all requests.
120+
Sampling can change the count, and evaluation and live calls can both return HTTP 200. No rows
121+
means no matching records in the selected scope/time range; it is not proof that nothing failed.
122+
Use the scoped and sampling-aware queries below for ongoing monitoring.
123+
95124
## 2. Single-region Function queries
96125

97126
### Requests, failures, and latency

‎docs/ONBOARDING.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ channel, pricing, and access to the provider's **EPP integration**, not just its
2020
An offer purchase does not deploy Azure resources, enable a Microsoft tenant feature, or install
2121
a missing adapter.
2222

23+
![Cropped examples of phone-provider offer cards in Microsoft Security Store](images/onboarding/security-store-providers.png)
24+
25+
*These are sample cards, not recommendations or a complete provider list. Offers, preview
26+
labels, pricing, and access can change. A store listing does not mean the setup script supports
27+
that integration; check [guided provider support](#provider-credential-names).*
28+
2329
Have your tenant administrator confirm the supported EPP onboarding/activation procedure with
2430
Microsoft and the provider **before incurring deployment costs**. This repository does not define
2531
tenant eligibility, licensing, preview enrollment, or a self-service activation entitlement.
37.8 KB
Loading
80.5 KB
Loading
-2.19 KB
Loading
3.06 KB
Loading
-32.8 KB
Loading
-19.1 KB
Loading

0 commit comments

Comments
 (0)