Skip to content

Commit 1edb4d7

Browse files
Hou Chi ChanCopilot
andcommitted
docs: show actual setup prompts and explain the approval preview
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 02c0e0f commit 1edb4d7

4 files changed

Lines changed: 46 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,18 +92,43 @@ Follow the prompts for your tenant, subscription, application, Azure region, pro
9292
Choose **one** language: JavaScript, C#, or Python. Setup downloads and verifies the package,
9393
builds it if needed, and deploys it for you; you do not need a separate ZIP upload or local settings file.
9494

95+
![Actual PowerShell setup prompts for tenant, subscription, application, region, and SMS or voice, with identifiers hidden](docs/images/onboarding/setup-identifiers.png)
96+
97+
*Enter your own values from Step 2. These are captures of the real script's terminal output,
98+
not example deployment results.*
99+
95100
Choose **FC1** for on-demand hosting that can scale to zero, or **EP1** for paid warm capacity.
96101
FC1 can cold-start, and its free usage grant does not make the whole deployment free.
97102
See [hosting plan details](setup/docs/README.md#service-plan-selection).
98103
The **Global/EU** prompt is a provider route label, not your Azure region or a data-residency guarantee.
99104
For the resource prefix, use 2-8 lowercase letters or digits, starting with a letter.
100105

106+
![Actual setup choices for channel, provider route, provider, language, and hosting plan, with provider names hidden](docs/images/onboarding/setup-choices.png)
107+
108+
*Choose the options approved for your deployment; do not copy the example selection numbers.
109+
The Global/EU choice is not the Azure region. The hosting-plan warning applies even when a
110+
plan has a free usage grant.*
111+
112+
Next, setup checks prerequisites, signs in to Azure and Microsoft Graph when needed, verifies
113+
the selected package, and prepares the deployment plan. Complete sign-in and MFA yourself.
114+
If a permission or prerequisite check fails, stop and resolve it before continuing.
115+
101116
**Review the complete deployment plan before typing `Yes`.** Check the accounts, region,
102117
provider route, plan, resource names, permissions, and certificate changes. Setup grants the
103118
Microsoft phone-provider service principal Microsoft Graph `Application.Read.All`, a tenant-wide
104119
application-read permission. `No` or Enter cancels deployment; sign-in and prerequisite prompts
105120
are separate from this approval.
106121

122+
**Want to review without deploying?** Run interactively and choose **No** at that final prompt.
123+
There is no `-DryRun` or `-WhatIf` switch. This is not an offline dry run: sign-in, prerequisite
124+
checks, downloads, and template compilation happen first. Do not pass `-ApproveDeployment`
125+
when you only want to review the plan.
126+
127+
After you approve, leave the script running while it configures the application, creates the
128+
Azure resources, sets up encryption and authentication, and publishes the code. Wait for
129+
**Deployment completed** and the saved summary before moving to Step 4. The input screenshots
130+
above do not show or prove that this deployment stage completed.
131+
107132
On success, setup has created the Function App, storage, Key Vault, identities, and monitoring
108133
resources, and published the endpoint code. **Do not create these resources manually first.**
109134
Keep the public certificate and timestamped summary in `epp-output` beside the script.
59.1 KB
Loading
30.7 KB
Loading

‎setup/docs/README.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,27 @@ The flow is:
263263
8. **Type `Yes` once to deploy.** `No` or Enter cancels without Azure changes. Invalid answers prompt
264264
again; individual resources do not request additional approvals.
265265

266+
### Reviewing the plan without deploying
267+
268+
`Setup-Epp.ps1` does not implement `-DryRun`, `-WhatIf`, or PowerShell `ShouldProcess`.
269+
To review a real plan, run interactively, complete preflight, then answer **No** or press Enter
270+
at `Deploy this complete plan? Type Yes or No [No]`. Do not supply `-ApproveDeployment`:
271+
that switch authorizes the deployment phase without asking again.
272+
273+
This is a cancellation at the approval gate, not an offline simulation. The existing application
274+
registration is still required. Before the plan appears, setup can download tools and packages,
275+
request prerequisite installation, sign in to Azure and Microsoft Graph, perform permission and
276+
region checks, verify package checksums, and compile Bicep. Installation and authentication/consent
277+
prompts are separate decisions. A preflight error is not a successful preview.
278+
279+
The [main guide's terminal captures](../../README.md#3-run-guided-setup) show real input screens,
280+
with identifying details and provider names hidden. The capture environment needed authenticated
281+
GitHub metadata access after its shared public-API quota was exhausted; that is not an additional
282+
prerequisite for ordinary setup. These input captures do not show deployment approval, resource
283+
creation, or the final completion summary.
284+
285+
### After approving the plan
286+
266287
After approval, setup rechecks the selected subscription and registers only missing
267288
`Microsoft.Web`, `Microsoft.Storage`, `Microsoft.KeyVault`, `Microsoft.OperationalInsights`,
268289
`Microsoft.Insights`, and `Microsoft.ManagedIdentity` providers. Already registered providers are

0 commit comments

Comments
 (0)