Skip to content

Commit fbda96e

Browse files
authored
Corrected Az.SignalR examples h3 header format (#25484)
Co-authored-by: Mike F. Robbins <[email protected]>
1 parent f894dbc commit fbda96e

11 files changed

+22
-22
lines changed

src/SignalR/SignalR/help/Get-AzSignalR.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Get a specific SignalR service or all the SignalR services in a resource group o
3535

3636
## EXAMPLES
3737

38-
### Get all SignalR services in the subscription
38+
### Example 1: Get all SignalR services in the subscription
3939
```powershell
4040
Get-AzSignalR
4141
```
@@ -48,7 +48,7 @@ mysignalr2.service.signalr.net eastus 5002 500
4848
mysignalr3.service.signalr.net eastus 5002 5001 Creating 1.0
4949
```
5050

51-
### Get all SignalR services in a resource group
51+
### Example 2: Get all SignalR services in a resource group
5252
```powershell
5353
Get-AzSignalR -ResourceGroupName myResourceGroup
5454
```
@@ -60,7 +60,7 @@ mysignalr1.service.signalr.net eastus 5002 500
6060
mysignalr2.service.signalr.net eastus 5002 5001 Succeeded 1.0
6161
```
6262

63-
### Get a specific SignalR service
63+
### Example 3: Get a specific SignalR service
6464
```powershell
6565
Get-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1
6666
```
@@ -71,7 +71,7 @@ HostName Location ServerPort Pub
7171
mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0
7272
```
7373

74-
### Get a specific SignalR service from the default resource group
74+
### Example 4: Get a specific SignalR service from the default resource group
7575
```powershell
7676
Get-AzSignalR -Name mysignalr2
7777
```

src/SignalR/SignalR/help/Get-AzSignalRKey.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Get the access keys of a SignalR service.
3535

3636
## EXAMPLES
3737

38-
### Get access keys of a specific SignalR service
38+
### Example 1: Get access keys of a specific SignalR service
3939
```powershell
4040
Get-AzSignalRKey -ResourceGroupName myResourceGroup -Name mysignalr1
4141
```
@@ -50,7 +50,7 @@ SecondaryConnectionString : Endpoint=https://mysignalr1.service.signalr.net;Acce
5050
XSjN4C/YFQ=;
5151
```
5252

53-
### Get access keys from a SignalR service object in pipe
53+
### Example 2: Get access keys from a SignalR service object in pipe
5454

5555
```powershell
5656
Get-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 | Get-AzSignalRKey

src/SignalR/SignalR/help/Get-AzSignalRUsage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Get the usage quota of a subscription.
2222

2323
## EXAMPLES
2424

25-
### Get the usage quota by inputting the location
25+
### Example 1: Get the usage quota by inputting the location
2626
```powershell
2727
Get-AzSignalRUsage eastus
2828
```

src/SignalR/SignalR/help/New-AzSignalR.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The following values will be used for the parameters if not specified:
2828

2929
## EXAMPLES
3030

31-
### Create a SignalR service
31+
### Example 1: Create a SignalR service
3232
```powershell
3333
New-AzSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr1 -Location eastus -Sku Standard_S1 -UnitCount 5
3434
```
@@ -39,7 +39,7 @@ HostName Location ExternalIp Sku
3939
mysignalr1.service.signalr.net eastus 52.179.3.5 Standard_S1 5 Succeeded 1.0
4040
```
4141

42-
### Specify ServiceMode and AllowedOrigin
42+
### Example 2: Specify ServiceMode and AllowedOrigin
4343
```powershell
4444
New-AzSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr2 -Location eastus -ServiceMode Serverless -AllowedOrigin http://example1.com:12345, https://example2.cn
4545
```

src/SignalR/SignalR/help/New-AzSignalRKey.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Regenerate an access key for a SignalR service.
3838

3939
## EXAMPLES
4040

41-
### Regenerate the primary key
41+
### Example 1: Regenerate the primary key
4242
```powershell
4343
New-AzSignalRKey -ResourceGroupName myResourceGroup -Name mysignalr1 -KeyType Primary -PassThru
4444
```

src/SignalR/SignalR/help/Remove-AzSignalR.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Remove a SignalR service.
3737

3838
## EXAMPLES
3939

40-
### Remove a SignalR service
40+
### Example 1: Remove a SignalR service
4141
```powershell
4242
Remove-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -PassThru
4343
```
@@ -46,7 +46,7 @@ Remove-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -PassThru
4646
True
4747
```
4848

49-
### Remove all SignalR service from pipe
49+
### Example 2: Remove all SignalR service from pipe
5050
```powershell
5151
Get-AzSignalR -ResourceGroupName myResourceGroup | Remove-AzSignalR
5252
```

src/SignalR/SignalR/help/Restart-AzSignalR.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Restart a SignalR service.
3737

3838
## EXAMPLES
3939

40-
### Restart a specific SignalR service
40+
### Example 1: Restart a specific SignalR service
4141
```powershell
4242
Restart-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -PassThru
4343
```

src/SignalR/SignalR/help/Set-AzSignalRUpstream.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Set the upstream settings of a SignalR service.
3838

3939
## EXAMPLES
4040

41-
### Set two ordered upstream templates
41+
### Example 1: Set two ordered upstream templates
4242
```powershell
4343
Set-AzSignalRUpstream -name pssignalr -ResourceGroupName test_resource_group -Template @{UrlTemplate='http://host-connections1.com'; HubPattern='chat';EventPattern='broadcast' }, @{UrlTemplate='http://host-connections2.com'}
4444
```
@@ -66,7 +66,7 @@ The following JSON represents the actual templates set.
6666
}
6767
`
6868

69-
### Clear all the upstream settings
69+
### Example 2: Clear all the upstream settings
7070
```powershell
7171
Set-AzSignalRUpstream -name pssignalr -ResourceGroupName test_resource_group -Clear
7272
```

src/SignalR/SignalR/help/Test-AzSignalRName.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Check the availability of a name. Alias: Test-AzSignal.
2222

2323
## EXAMPLES
2424

25-
### Check an existed name.
25+
### Example 1: Check an existed name.
2626
```powershell
2727
Test-AzSignalRName -Name existedsignalr -Location eastus
2828
```
@@ -31,7 +31,7 @@ Test-AzSignalRName -Name existedsignalr -Location eastus
3131
False
3232
```
3333

34-
### Check an unexisted name.
34+
### Example 2: Check an unexisted name.
3535
```powershell
3636
Test-AzSignalRName -Name unexistedsignalr -Location eastus
3737
```

src/SignalR/SignalR/help/Update-AzSignalR.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The following values will be used for the parameters if not specified:
4444

4545
## EXAMPLES
4646

47-
### Update a specific SignalR service.
47+
### Example 1: Update a specific SignalR service.
4848
```powershell
4949
Update-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -UnitCount 5
5050
```
@@ -55,7 +55,7 @@ HostName Location ExternalIp Sku
5555
mysignalr1.service.signalr.net eastus 52.179.3.5 Standard_S1 5 Succeeded 1.0
5656
```
5757

58-
### Specify ServiceMode and AllowedOrigin
58+
### Example 2: Specify ServiceMode and AllowedOrigin
5959
```powershell
6060
Update-AzSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr2 -ServiceMode Serverless -AllowedOrigin http://example1.com:12345, https://example2.cn
6161
```

0 commit comments

Comments
 (0)