Skip to content

Commit c0c3a77

Browse files
Split Az.Portal Examples in generation (#17284)
1 parent cf61bea commit c0c3a77

10 files changed

+42
-18
lines changed

src/Portal/docs/Get-AzPortalDashboard.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,24 @@ Gets the Dashboard.
4141

4242
### Example 1: List all dashboards in a subscription
4343
```powershell
44-
PS C:> Get-AzPortalDashboard
44+
Get-AzPortalDashboard
45+
```
46+
47+
```output
4548
Location Name Type
4649
-------- ---- ----
4750
eastasia my-custom-dashboard1 Microsoft.Portal/dashboards
4851
westus my-second-custom-dashboard1 Microsoft.Portal/dashboards
49-
5052
```
5153

5254
List all dashboards in a subscription
5355

5456
### Example 2: Get details for a single Portal Dashboard
5557
```powershell
56-
PS C:\> Get-AzPortalDashboard -ResourceGroupName my-rg -Name mydashboard
58+
Get-AzPortalDashboard -ResourceGroupName my-rg -Name mydashboard
59+
```
5760

61+
```output
5862
Location Name Type
5963
-------- ---- ----
6064
eastus mydashboard Microsoft.Portal/dashboards

src/Portal/docs/New-AzPortalDashboard.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,10 @@ Creates or updates a Dashboard.
3838

3939
### Example 1: Create a dashboard using a dashboard template file
4040
```powershell
41-
PS C:\> New-AzPortalDashboard -DashboardPath .\resources\dash1.json -ResourceGroupName mydash-rg -DashboardName my-dashboard03
41+
New-AzPortalDashboard -DashboardPath .\resources\dash1.json -ResourceGroupName mydash-rg -DashboardName my-dashboard03
42+
```
4243

44+
```output
4345
Location Name Type
4446
-------- ---- ----
4547
eastasia my-dashboard03 Microsoft.Portal/dashboards

src/Portal/docs/Remove-AzPortalDashboard.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ Deletes the Dashboard.
3131

3232
### Example 1: Remove a Dashboard
3333
```powershell
34-
PS C:\td\> Remove-AzPortalDashboard -ResourceGroupName my-rg -DashboardName dashbase02
34+
Remove-AzPortalDashboard -ResourceGroupName my-rg -DashboardName dashbase02
3535
```
3636

3737
Remove a Dashbaord using resource group name and dashboard name.
3838

3939
### Example 2: Remove a Dashboard using the pipeline
4040
```powershell
41-
PS C:\> Get-AzPortalDashboard -ResourceGroupName my-rg -DashboardName dashbase02 | Remove-AzPortalDashboard
41+
Get-AzPortalDashboard -ResourceGroupName my-rg -DashboardName dashbase02 | Remove-AzPortalDashboard
4242
```
4343

4444
Remove the dashboard returned from a Get-AzDashboard call.

src/Portal/docs/Set-AzPortalDashboard.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ Creates or updates a Dashboard.
2424

2525
### Example 1: Update the dashboard definition using a dashboard template
2626
```powershell
27-
PS C:\> Set-AzPortalDashboard -DashboardPath .\resources\dash1-update.json -ResourceGroupName my-rg -DashboardName dashbase03
27+
Set-AzPortalDashboard -DashboardPath .\resources\dash1-update.json -ResourceGroupName my-rg -DashboardName dashbase03
28+
```
2829

30+
```output
2931
Location Name Type
3032
-------- ---- ----
3133
eastasia dashbase03 Microsoft.Portal/dashboards

src/Portal/docs/Update-AzPortalDashboard.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,10 @@ Updates an existing Dashboard.
3232

3333
### Example 1: Update the Tags of a Dashboard
3434
```powershell
35-
PS C:\> Update-AzPortalDashboard -ResourceGroupName my-rg -Name dashbase03 -Tag @{'hidden-title'="My Dashboard Title"; NewTag="NewValue"}
35+
Update-AzPortalDashboard -ResourceGroupName my-rg -Name dashbase03 -Tag @{'hidden-title'="My Dashboard Title"; NewTag="NewValue"}
36+
```
3637

38+
```output
3739
Location Name Type
3840
-------- ---- ----
3941
eastasia dashbase03 Microsoft.Portal/dashboards
@@ -44,8 +46,10 @@ Tags are represented as an inline hashtable.
4446

4547
### Example 2: Update Dashboard tags using the pipeline
4648
```powershell
47-
PS C:\> Get-AzPortalDashboard -ResourceGroupName my-rg -Name dashbase03 | Update-AzPortalDashboard -Tag @{'hidden-title'="My Dashboard Title"; NewTag="NewValue"}
49+
Get-AzPortalDashboard -ResourceGroupName my-rg -Name dashbase03 | Update-AzPortalDashboard -Tag @{'hidden-title'="My Dashboard Title"; NewTag="NewValue"}
50+
```
4851

52+
```output
4953
Location Name Type
5054
-------- ---- ----
5155
eastasia dashbase03 Microsoft.Portal/dashboards

src/Portal/examples/Get-AzPortalDashboard.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
11
### Example 1: List all dashboards in a subscription
22
```powershell
3-
PS C:> Get-AzPortalDashboard
3+
Get-AzPortalDashboard
4+
```
5+
6+
```output
47
Location Name Type
58
-------- ---- ----
69
eastasia my-custom-dashboard1 Microsoft.Portal/dashboards
710
westus my-second-custom-dashboard1 Microsoft.Portal/dashboards
8-
911
```
1012

1113
List all dashboards in a subscription
1214

1315
### Example 2: Get details for a single Portal Dashboard
1416
```powershell
15-
PS C:\> Get-AzPortalDashboard -ResourceGroupName my-rg -Name mydashboard
17+
Get-AzPortalDashboard -ResourceGroupName my-rg -Name mydashboard
18+
```
1619

20+
```output
1721
Location Name Type
1822
-------- ---- ----
1923
eastus mydashboard Microsoft.Portal/dashboards

src/Portal/examples/New-AzPortalDashboard.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
### Example 1: Create a dashboard using a dashboard template file
22
```powershell
3-
PS C:\> New-AzPortalDashboard -DashboardPath .\resources\dash1.json -ResourceGroupName mydash-rg -DashboardName my-dashboard03
3+
New-AzPortalDashboard -DashboardPath .\resources\dash1.json -ResourceGroupName mydash-rg -DashboardName my-dashboard03
4+
```
45

6+
```output
57
Location Name Type
68
-------- ---- ----
79
eastasia my-dashboard03 Microsoft.Portal/dashboards

src/Portal/examples/Remove-AzPortalDashboard.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
### Example 1: Remove a Dashboard
22
```powershell
3-
PS C:\td\> Remove-AzPortalDashboard -ResourceGroupName my-rg -DashboardName dashbase02
3+
Remove-AzPortalDashboard -ResourceGroupName my-rg -DashboardName dashbase02
44
```
55

66
Remove a Dashbaord using resource group name and dashboard name.
77

88
### Example 2: Remove a Dashboard using the pipeline
99
```powershell
10-
PS C:\> Get-AzPortalDashboard -ResourceGroupName my-rg -DashboardName dashbase02 | Remove-AzPortalDashboard
10+
Get-AzPortalDashboard -ResourceGroupName my-rg -DashboardName dashbase02 | Remove-AzPortalDashboard
1111
```
1212

1313
Remove the dashboard returned from a Get-AzDashboard call.

src/Portal/examples/Set-AzPortalDashboard.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
### Example 1: Update the dashboard definition using a dashboard template
22
```powershell
3-
PS C:\> Set-AzPortalDashboard -DashboardPath .\resources\dash1-update.json -ResourceGroupName my-rg -DashboardName dashbase03
3+
Set-AzPortalDashboard -DashboardPath .\resources\dash1-update.json -ResourceGroupName my-rg -DashboardName dashbase03
4+
```
45

6+
```output
57
Location Name Type
68
-------- ---- ----
79
eastasia dashbase03 Microsoft.Portal/dashboards

src/Portal/examples/Update-AzPortalDashboard.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
### Example 1: Update the Tags of a Dashboard
22
```powershell
3-
PS C:\> Update-AzPortalDashboard -ResourceGroupName my-rg -Name dashbase03 -Tag @{'hidden-title'="My Dashboard Title"; NewTag="NewValue"}
3+
Update-AzPortalDashboard -ResourceGroupName my-rg -Name dashbase03 -Tag @{'hidden-title'="My Dashboard Title"; NewTag="NewValue"}
4+
```
45

6+
```output
57
Location Name Type
68
-------- ---- ----
79
eastasia dashbase03 Microsoft.Portal/dashboards
@@ -11,8 +13,10 @@ Update the tags in a dashboard. Tags are represented as an inline hashtable.
1113

1214
### Example 2: Update Dashboard tags using the pipeline
1315
```powershell
14-
PS C:\> Get-AzPortalDashboard -ResourceGroupName my-rg -Name dashbase03 | Update-AzPortalDashboard -Tag @{'hidden-title'="My Dashboard Title"; NewTag="NewValue"}
16+
Get-AzPortalDashboard -ResourceGroupName my-rg -Name dashbase03 | Update-AzPortalDashboard -Tag @{'hidden-title'="My Dashboard Title"; NewTag="NewValue"}
17+
```
1518

19+
```output
1620
Location Name Type
1721
-------- ---- ----
1822
eastasia dashbase03 Microsoft.Portal/dashboards

0 commit comments

Comments
 (0)