Skip to content

Commit 3ee3f12

Browse files
committed
docs: address review feedback on ARM samples
- Rename ARM JSON heading to 'ARM with Known Permissions (JSON File format)' - Quote @file paths in PowerShell --initialPermissions examples - Update Bicep JSON output description to flat scope->permissions map
1 parent 1f8a924 commit 3ee3f12

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

docs/commandline-flags-and-env-variables.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ $env:MPF_SPOBJECTID = "YOUR_SP_OBJECT_ID"
158158
--verbose
159159
```
160160

161-
### Example: ARM with JSON File Format
161+
### Example: ARM with Known Permissions (JSON File format)
162162

163163
For ARM templates with many pre-requisite permissions, using a JSON file is cleaner. Create a file called `arm-initial-permissions.json`:
164164

@@ -202,7 +202,7 @@ $env:MPF_SPCLIENTSECRET = "YOUR_SP_CLIENT_SECRET"
202202
$env:MPF_SPOBJECTID = "YOUR_SP_OBJECT_ID"
203203
204204
.\azmpf.exe arm `
205-
--initialPermissions @arm-initial-permissions.json `
205+
--initialPermissions "@arm-initial-permissions.json" `
206206
--templateFilePath .\samples\templates\aks-private-subnet.json `
207207
--parametersFilePath .\samples\templates\aks-private-subnet-parameters.json `
208208
--verbose
@@ -290,7 +290,7 @@ $env:MPF_SPOBJECTID = "YOUR_SP_OBJECT_ID"
290290
$env:MPF_BICEPEXECPATH = "C:\Program Files\Azure Bicep CLI\bicep.exe"
291291
292292
.\azmpf.exe bicep `
293-
--initialPermissions @bicep-backend-permissions.json `
293+
--initialPermissions "@bicep-backend-permissions.json" `
294294
--bicepFilePath .\samples\bicep\aks-private-subnet.bicep `
295295
--parametersFilePath .\samples\bicep\aks-private-subnet-params.json `
296296
--verbose

docs/display-options.MD

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ export MPF_BICEPEXECPATH=$(which bicep)
208208
azmpf bicep --bicepFilePath ./samples/bicep/storage-account-simple.bicep --parametersFilePath ./samples/bicep/storage-account-simple-params.json --jsonOutput --verbose
209209
```
210210

211-
Output shows JSON with permissions array and permissionsByResourceScope details (similar to ARM example above).
211+
The Bicep JSON output uses the same format as the ARM example above: a flat map where the subscription ID key contains all aggregate permissions, and each resource scope key contains permissions specific to that resource.
212212

213213
### Bicep Detailed Output
214214

docs/installation-and-quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ $env:MPF_SPCLIENTSECRET = "YOUR_SP_CLIENT_SECRET"
265265
$env:MPF_SPOBJECTID = "YOUR_SP_OBJECT_ID"
266266
267267
.\azmpf.exe arm --templateFilePath .\samples\templates\aks-private-subnet.json --parametersFilePath .\samples\templates\aks-private-subnet-parameters.json `
268-
--initialPermissions @arm-initial-permissions.json `
268+
--initialPermissions "@arm-initial-permissions.json" `
269269
--verbose
270270
```
271271

0 commit comments

Comments
 (0)