Skip to content

Commit 92df543

Browse files
Merge pull request #231629 from davidsmatlak/ds-fixes-0321
Fixes placeholders in code samples
2 parents 10c59dc + c5001c8 commit 92df543

File tree

2 files changed

+39
-39
lines changed

2 files changed

+39
-39
lines changed

articles/azure-resource-manager/managed-applications/publish-service-catalog-app.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: davidsmatlak
55
ms.author: davidsmatlak
66
ms.topic: quickstart
77
ms.custom: subject-armqs, devx-track-azurecli, devx-track-azurepowershell, subject-rbac-steps, mode-api, mode-arm
8-
ms.date: 03/17/2023
8+
ms.date: 03/21/2023
99
---
1010

1111
# Quickstart: Create and publish an Azure Managed Application definition
@@ -261,7 +261,7 @@ To learn more, see [Get started with CreateUiDefinition](create-uidefinition-ove
261261

262262
Add the two files to a package file named _app.zip_. The two files must be at the root level of the _.zip_ file. If the files are in a folder, when you create the managed application definition, you receive an error that states the required files aren't present.
263263

264-
Upload _app.zip_ to an Azure storage account so you can use it when you deploy the managed application's definition. The storage account name must be globally unique across Azure and the length must be 3-24 characters with only lowercase letters and numbers. In the `Name` parameter, replace the placeholder `demostorageaccount` with your unique storage account name.
264+
Upload _app.zip_ to an Azure storage account so you can use it when you deploy the managed application's definition. The storage account name must be globally unique across Azure and the length must be 3-24 characters with only lowercase letters and numbers. In the command, replace the placeholder `<demostorageaccount>` including the angle brackets (`<>`), with your unique storage account name.
265265

266266
# [PowerShell](#tab/azure-powershell)
267267

@@ -278,7 +278,7 @@ New-AzResourceGroup -Name packageStorageGroup -Location westus3
278278
279279
$storageAccount = New-AzStorageAccount `
280280
-ResourceGroupName packageStorageGroup `
281-
-Name "demostorageaccount" `
281+
-Name "<demostorageaccount>" `
282282
-Location westus3 `
283283
-SkuName Standard_LRS `
284284
-Kind StorageV2
@@ -308,7 +308,7 @@ The command opens your default browser and prompts you to sign in to Azure. For
308308
az group create --name packageStorageGroup --location westus3
309309
310310
az storage account create \
311-
--name demostorageaccount \
311+
--name <demostorageaccount> \
312312
--resource-group packageStorageGroup \
313313
--location westus3 \
314314
--sku Standard_LRS \
@@ -321,13 +321,13 @@ After you add the role to the storage account, it takes a few minutes to become
321321

322322
```azurecli
323323
az storage container create \
324-
--account-name demostorageaccount \
324+
--account-name <demostorageaccount> \
325325
--name appcontainer \
326326
--auth-mode login \
327327
--public-access blob
328328
329329
az storage blob upload \
330-
--account-name demostorageaccount \
330+
--account-name <demostorageaccount> \
331331
--container-name appcontainer \
332332
--auth-mode login \
333333
--name "app.zip" \
@@ -404,12 +404,12 @@ The next step is to select a user, security group, or application for managing t
404404

405405
# [PowerShell](#tab/azure-powershell)
406406

407-
This example uses a security group, and your Azure Active Directory account should be a member of the group. To get the group's object ID, replace the placeholder `managedAppDemo` with your group's name. You use this variable's value when you deploy the managed application definition.
407+
This example uses a security group, and your Azure Active Directory account should be a member of the group. To get the group's object ID, replace the placeholder `<managedAppDemo>` including the angle brackets (`<>`), with your group's name. You use this variable's value when you deploy the managed application definition.
408408

409409
To create a new Azure Active Directory group, go to [Manage Azure Active Directory groups and group membership](../../active-directory/fundamentals/how-to-manage-groups.md).
410410

411411
```azurepowershell
412-
$principalid=(Get-AzADGroup -DisplayName managedAppDemo).Id
412+
$principalid=(Get-AzADGroup -DisplayName <managedAppDemo>).Id
413413
```
414414

415415
Next, get the role definition ID of the Azure built-in role you want to grant access to the user, group, or application. You use this variable's value when you deploy the managed application definition.
@@ -420,12 +420,12 @@ $roleid=(Get-AzRoleDefinition -Name Owner).Id
420420

421421
# [Azure CLI](#tab/azure-cli)
422422

423-
This example uses a security group, and your Azure Active Directory account should be a member of the group. To get the group's object ID, replace the placeholder `managedAppDemo` with your group's name. You use this variable's value when you deploy the managed application definition.
423+
This example uses a security group, and your Azure Active Directory account should be a member of the group. To get the group's object ID, replace the placeholder `<managedAppDemo>` including the angle brackets (`<>`), with your group's name. You use this variable's value when you deploy the managed application definition.
424424

425425
To create a new Azure Active Directory group, go to [Manage Azure Active Directory groups and group membership](../../active-directory/fundamentals/how-to-manage-groups.md).
426426

427427
```azurecli
428-
principalid=$(az ad group show --group managedAppDemo --query id --output tsv)
428+
principalid=$(az ad group show --group <managedAppDemo> --query id --output tsv)
429429
```
430430

431431
Next, get the role definition ID of the Azure built-in role you want to grant access to the user, group, or application. You use this variable's value when you deploy the managed application definition.
@@ -485,11 +485,11 @@ Create a resource group for your managed application definition.
485485
az group create --name appDefinitionGroup --location westus3
486486
```
487487

488-
In the `blob` command's `account-name` parameter, replace the placeholder `demostorageaccount` with your unique storage account name. The `blob` command creates a variable to store the URL for the package _.zip_ file. That variable is used in the command that creates the managed application definition.
488+
In the `blob` command's `account-name` parameter, replace the placeholder `<demostorageaccount>` including the angle brackets (`<>`), with your unique storage account name. The `blob` command creates a variable to store the URL for the package _.zip_ file. That variable is used in the command that creates the managed application definition.
489489

490490
```azurecli
491491
blob=$(az storage blob url \
492-
--account-name demostorageaccount \
492+
--account-name <demostorageaccount> \
493493
--container-name appcontainer \
494494
--auth-mode login \
495495
--name app.zip --output tsv)

articles/azure-resource-manager/managed-applications/publish-service-catalog-bring-your-own-storage.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: davidsmatlak
55
ms.author: davidsmatlak
66
ms.topic: quickstart
77
ms.custom: subject-armqs, devx-track-azurecli, devx-track-azurepowershell, subject-rbac-steps, mode-api, mode-arm
8-
ms.date: 03/01/2023
8+
ms.date: 03/21/2023
99
---
1010

1111
# Quickstart: Bring your own storage to create and publish an Azure Managed Application definition
@@ -262,7 +262,7 @@ To learn more, go to [Get started with CreateUiDefinition](create-uidefinition-o
262262

263263
Add the two files to a package file named _app.zip_. The two files must be at the root level of the _.zip_ file. If the files are in a folder, when you create the managed application definition, you receive an error that states the required files aren't present.
264264

265-
Upload _app.zip_ to an Azure storage account so you can use it when you deploy the managed application's definition. The storage account name must be globally unique across Azure and the length must be 3-24 characters with only lowercase letters and numbers. In the `Name` parameter, replace the placeholder `demostorageaccount` with your unique storage account name.
265+
Upload _app.zip_ to an Azure storage account so you can use it when you deploy the managed application's definition. The storage account name must be globally unique across Azure and the length must be 3-24 characters with only lowercase letters and numbers. In the command, replace the placeholder `<demostorageaccount>` including the angle brackets (`<>`), with your unique storage account name.
266266

267267
# [PowerShell](#tab/azure-powershell)
268268

@@ -271,7 +271,7 @@ New-AzResourceGroup -Name packageStorageGroup -Location westus3
271271
272272
$storageAccount = New-AzStorageAccount `
273273
-ResourceGroupName packageStorageGroup `
274-
-Name "demostorageaccount" `
274+
-Name "<demostorageaccount>" `
275275
-Location westus3 `
276276
-SkuName Standard_LRS `
277277
-Kind StorageV2
@@ -299,7 +299,7 @@ $packageuri=(Get-AzStorageBlob -Container appcontainer -Blob app.zip -Context $c
299299
az group create --name packageStorageGroup --location westus3
300300
301301
az storage account create \
302-
--name demostorageaccount \
302+
--name <demostorageaccount> \
303303
--resource-group packageStorageGroup \
304304
--location westus3 \
305305
--sku Standard_LRS \
@@ -312,13 +312,13 @@ After you add the role to the storage account, it takes a few minutes to become
312312

313313
```azurecli
314314
az storage container create \
315-
--account-name demostorageaccount \
315+
--account-name <demostorageaccount> \
316316
--name appcontainer \
317317
--auth-mode login \
318318
--public-access blob
319319
320320
az storage blob upload \
321-
--account-name demostorageaccount \
321+
--account-name <demostorageaccount> \
322322
--container-name appcontainer \
323323
--auth-mode login \
324324
--name "app.zip" \
@@ -331,7 +331,7 @@ Use the following command to store the package file's URI in a variable named `p
331331

332332
```azurecli
333333
packageuri=$(az storage blob url \
334-
--account-name demostorageaccount \
334+
--account-name <demostorageaccount> \
335335
--container-name appcontainer \
336336
--auth-mode login \
337337
--name app.zip --output tsv)
@@ -350,7 +350,7 @@ You store your managed application definition in your own storage account so tha
350350

351351
Create the storage account for your managed application definition. The storage account name must be globally unique across Azure and the length must be 3-24 characters with only lowercase letters and numbers.
352352

353-
This example creates a new resource group named `byosDefinitionStorageGroup`. In the `Name` parameter, replace the placeholder `definitionstorage` with your unique storage account name.
353+
This example creates a new resource group named `byosDefinitionStorageGroup`. In the command, replace the placeholder `<definitionstorage>` including the angle brackets (`<>`), with your unique storage account name.
354354

355355
# [PowerShell](#tab/azure-powershell)
356356

@@ -359,7 +359,7 @@ New-AzResourceGroup -Name byosDefinitionStorageGroup -Location westus3
359359
360360
New-AzStorageAccount `
361361
-ResourceGroupName byosDefinitionStorageGroup `
362-
-Name "definitionstorage" `
362+
-Name "<definitionstorage>" `
363363
-Location westus3 `
364364
-SkuName Standard_LRS `
365365
-Kind StorageV2
@@ -368,7 +368,7 @@ New-AzStorageAccount `
368368
Use the following command to store the storage account's resource ID in a variable named `storageid`. You use the variable's value when you deploy the managed application definition.
369369

370370
```azurepowershell
371-
$storageid = (Get-AzStorageAccount -ResourceGroupName byosDefinitionStorageGroup -Name definitionstorage).Id
371+
$storageid = (Get-AzStorageAccount -ResourceGroupName byosDefinitionStorageGroup -Name <definitionstorage>).Id
372372
```
373373

374374
# [Azure CLI](#tab/azure-cli)
@@ -377,7 +377,7 @@ $storageid = (Get-AzStorageAccount -ResourceGroupName byosDefinitionStorageGroup
377377
az group create --name byosDefinitionStorageGroup --location westus3
378378
379379
az storage account create \
380-
--name definitionstorage \
380+
--name <definitionstorage> \
381381
--resource-group byosDefinitionStorageGroup \
382382
--location westus3 \
383383
--sku Standard_LRS \
@@ -387,7 +387,7 @@ az storage account create \
387387
Use the following command to store the storage account's resource ID in a variable named `storageid`. You use the variable's value to set up the storage account's role assignment and when you deploy the managed application definition.
388388

389389
```azurecli
390-
storageid=$(az storage account show --resource-group byosDefinitionStorageGroup --name definitionstorage --query id --output tsv)
390+
storageid=$(az storage account show --resource-group byosDefinitionStorageGroup --name <definitionstorage> --query id --output tsv)
391391
```
392392

393393
---
@@ -430,20 +430,20 @@ The _Appliance Resource Provider_ is a service principal in your Azure Active Di
430430

431431
The next step is to select a user, security group, or application for managing the resources for the customer. This identity has permissions on the managed resource group according to the assigned role. The role can be any Azure built-in role like Owner or Contributor.
432432

433-
This example uses a security group, and your Azure Active Directory account should be a member of the group. To get the group's object ID, replace the placeholder `managedAppDemo` with your group's name. You use the variable's value when you deploy the managed application definition.
433+
This example uses a security group, and your Azure Active Directory account should be a member of the group. To get the group's object ID, replace the placeholder `<managedAppDemo>` including the angle brackets (`<>`), with your group's name. You use the variable's value when you deploy the managed application definition.
434434

435435
To create a new Azure Active Directory group, go to [Manage Azure Active Directory groups and group membership](../../active-directory/fundamentals/how-to-manage-groups.md).
436436

437437
# [PowerShell](#tab/azure-powershell)
438438

439439
```azurepowershell
440-
$principalid=(Get-AzADGroup -DisplayName managedAppDemo).Id
440+
$principalid=(Get-AzADGroup -DisplayName <managedAppDemo>).Id
441441
```
442442

443443
# [Azure CLI](#tab/azure-cli)
444444

445445
```azurecli
446-
principalid=$(az ad group show --group managedAppDemo --query id --output tsv)
446+
principalid=$(az ad group show --group <managedAppDemo> --query id --output tsv)
447447
```
448448

449449
---
@@ -523,27 +523,27 @@ The managed application definition's deployment template needs input for several
523523

524524
In Visual Studio Code, create a new file named _deployDefinition.parameters.json_ and save it.
525525

526-
Add the following to your parameter file and save it. Then, replace the `{placeholder values}` including the curly braces, with your values.
526+
Add the following to your parameter file and save it. Then, replace the `<placeholder values>` including the angle brackets (`<>`), with your values.
527527

528528
```json
529529
{
530530
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
531531
"contentVersion": "1.0.0.0",
532532
"parameters": {
533533
"managedApplicationDefinitionName": {
534-
"value": "{placeholder for managed application name}"
534+
"value": "<placeholder for managed application name>"
535535
},
536536
"definitionStorageResourceID": {
537-
"value": "{placeholder for you storage account ID}"
537+
"value": "<placeholder for you storage account ID>"
538538
},
539539
"packageFileUri": {
540-
"value": "{placeholder for the packageFileUri}"
540+
"value": "<placeholder for the packageFileUri>"
541541
},
542542
"principalId": {
543-
"value": "{placeholder for principalid value}"
543+
"value": "<placeholder for principalid value>"
544544
},
545545
"roleId": {
546-
"value": "{placeholder for roleid value}"
546+
"value": "<placeholder for roleid value>"
547547
}
548548
}
549549
}
@@ -559,9 +559,9 @@ The following table describes the parameter values for the managed application d
559559
| `principalId` | The publishers Principal ID that needs permissions to manage resources in the managed resource group. Use your `principalid` variable's value. |
560560
| `roleId` | Role ID for permissions to the managed resource group. For example Owner, Contributor, Reader. Use your `roleid` variable's value. |
561561

562-
To get your variable values from the command prompt:
563-
- Azure PowerShell: type `$variableName` to display the value.
564-
- Azure CLI: type `echo $variableName` to display the value.
562+
To get your variable values:
563+
- Azure PowerShell: In PowerShell, type `$variableName` to display a variable's value.
564+
- Azure CLI: In Bash, type `echo $variableName` to display a variable's value.
565565

566566
## Deploy the definition
567567

@@ -597,12 +597,12 @@ az deployment group create \
597597

598598
During deployment, the template's `storageAccountId` property uses your storage account's resource ID and creates a new container with the case-sensitive name `applicationdefinitions`. The files from the _.zip_ package you specified during the deployment are stored in the new container.
599599

600-
You can use the following commands to verify that the managed application definition files are saved in your storage account's container. In the `Name` parameter, replace the placeholder `definitionstorage` with your unique storage account name.
600+
You can use the following commands to verify that the managed application definition files are saved in your storage account's container. In the command, replace the placeholder `<definitionstorage>` including the angle brackets (`<>`), with your unique storage account name.
601601

602602
# [PowerShell](#tab/azure-powershell)
603603

604604
```azurepowershell
605-
Get-AzStorageAccount -ResourceGroupName byosDefinitionStorageGroup -Name definitionstorage |
605+
Get-AzStorageAccount -ResourceGroupName byosDefinitionStorageGroup -Name <definitionstorage> |
606606
Get-AzStorageContainer -Name applicationdefinitions |
607607
Get-AzStorageBlob | Select-Object -Property Name | Format-List
608608
```
@@ -612,7 +612,7 @@ Get-AzStorageBlob | Select-Object -Property Name | Format-List
612612
```azurecli
613613
az storage blob list \
614614
--container-name applicationdefinitions \
615-
--account-name definitionstorage \
615+
--account-name <definitionstorage> \
616616
--query "[].{Name:name}"
617617
```
618618

0 commit comments

Comments
 (0)