Skip to content

Commit 4e07e84

Browse files
Split Az.SignalR Examples in generation (#17338)
1 parent ed6e217 commit 4e07e84

26 files changed

+142
-74
lines changed

src/SignalR/SignalR.Autorest/docs/Get-AzWebPubSub.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,10 @@ Get the resource and its properties.
4141

4242
### Example 1: List all Web PubSub resources in a subscription
4343
```powershell
44-
PS C:\> Get-AzWebPubSub -SubscriptionId ef72249e-9785-4799-a76b-7cdd80e1b1d0
44+
Get-AzWebPubSub -SubscriptionId ef72249e-9785-4799-a76b-7cdd80e1b1d0
45+
```
4546

47+
```output
4648
Name Location SkuName
4749
---- -------- -------
4850
demo1 eastus Standard_S1
@@ -53,8 +55,10 @@ demo2 eastus Free_F1
5355

5456
### Example 2: List all Web PubSub resources in a resource group
5557
```powershell
56-
PS C:\> Get-AzWebPubSub -ResourceGroupName psdemo
58+
Get-AzWebPubSub -ResourceGroupName psdemo
59+
```
5760

61+
```output
5862
Name Location SkuName
5963
---- -------- -------
6064
psdemo-wps eastus Standard_S1
@@ -64,8 +68,10 @@ psdemo-wps eastus Standard_S1
6468

6569
### Example 3: Get a specific Web PubSub resource
6670
```powershell
67-
PS C:\> Get-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps
71+
Get-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps
72+
```
6873

74+
```output
6975
Name Location SkuName
7076
---- -------- -------
7177
psdemo-wps eastus Standard_S1
@@ -75,12 +81,14 @@ psdemo-wps eastus Standard_S1
7581

7682
### Example 4: Get a specific Web PubSub resource via identity object
7783
```powershell
78-
PS C:\> $identity = @{ ResourceGroupName = 'psdemo'
84+
$identity = @{ ResourceGroupName = 'psdemo'
7985
ResourceName = 'psdemo-wps'
8086
SubscriptionId = $(Get-AzContext).Subscription.Id }
8187
82-
PS C:\> $identity | Get-AzWebPubSub
88+
$identity | Get-AzWebPubSub
89+
```
8390

91+
```output
8492
Name Location SkuName
8593
---- -------- -------
8694
psdemo-wps eastus Standard_S1

src/SignalR/SignalR.Autorest/docs/Get-AzWebPubSubHub.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,10 @@ Get a hub setting.
3636

3737
### Example 1: List hub settings of a Web PubSub resource.
3838
```powershell
39-
PS C:\> Get-AzWebPubSubHub -ResourceGroupName psdemo -ResourceName psdemo-wps
39+
Get-AzWebPubSubHub -ResourceGroupName psdemo -ResourceName psdemo-wps
40+
```
4041

42+
```output
4143
Name AnonymousConnectPolicy
4244
---- ----------------------
4345
testHub deny
@@ -48,8 +50,10 @@ testHub2 deny
4850

4951
### Example 2: Get a Web PubSub hub setting.
5052
```powershell
51-
PS C:\> Get-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps
53+
Get-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps
54+
```
5255

56+
```output
5357
Name AnonymousConnectPolicy
5458
---- ----------------------
5559
testHub deny
@@ -59,12 +63,14 @@ testHub deny
5963

6064
### Example 3: Get a Web PubSub hub setting via identity.
6165
```powershell
62-
PS C:\> $hubIdentity = @{ ResourceGroupName = 'psdemo'
66+
$hubIdentity = @{ ResourceGroupName = 'psdemo'
6367
ResourceName = 'psdemo-wps'
6468
SubscriptionId = $(Get-AzContext).Subscription.Id
6569
HubName = 'testHub' }
66-
PS C:\> $hubIdentity | Get-AzWebPubSubHub
70+
$hubIdentity | Get-AzWebPubSubHub
71+
```
6772

73+
```output
6874
Name AnonymousConnectPolicy
6975
---- ----------------------
7076
testHub deny

src/SignalR/SignalR.Autorest/docs/Get-AzWebPubSubKey.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@ Get the access keys of the resource.
3131

3232
### Example 1: Get the access keys of a Web PubSub resource
3333
```powershell
34-
PS C:\> Get-AzWebPubSubKey -ResourceGroupName psdemo -ResourceName psdemo-wps | Format-List
34+
Get-AzWebPubSubKey -ResourceGroupName psdemo -ResourceName psdemo-wps | Format-List
35+
```
3536

37+
```output
3638
PrimaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0;
3739
PrimaryKey : ********
3840
SecondaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0;
@@ -43,9 +45,11 @@ The example gets the access keys of the Web PubSub resource and then pipes the r
4345

4446
### Example 2: Get the access keys of a Web PubSub resource via identity
4547
```powershell
46-
PS C:\> $wps = Get-AzWebPubSub -ResourceGroupName psdemo -ResourceName psdemo-wps
47-
PS C:\> $wps | Get-AzWebPubSubKey | Format-List
48+
$wps = Get-AzWebPubSub -ResourceGroupName psdemo -ResourceName psdemo-wps
49+
$wps | Get-AzWebPubSubKey | Format-List
50+
```
4851

52+
```output
4953
PrimaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0;
5054
PrimaryKey : ********
5155
SecondaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0;

src/SignalR/SignalR.Autorest/docs/Get-AzWebPubSubSku.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ List all available skus of the resource.
2424

2525
### Example 1: List all available SKUs of a Web PubSub resource
2626
```powershell
27-
PS C:\> Get-AzWebPubSubSku -ResourceGroupName psdemo -ResourceName psdemo-wps | Format-List
27+
Get-AzWebPubSubSku -ResourceGroupName psdemo -ResourceName psdemo-wps | Format-List
28+
```
2829

30+
```output
2931
CapacityAllowedValue : {0, 1}
3032
CapacityDefault : 1
3133
CapacityMaximum : 1

src/SignalR/SignalR.Autorest/docs/Get-AzWebPubSubUsage.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ List resource usage quotas by location.
2424

2525
### Example 1: List Web PubSub usage in east US region.
2626
```powershell
27-
PS C:\> Get-AzWebPubSubUsage -Location eastus | Format-List
27+
Get-AzWebPubSubUsage -Location eastus | Format-List
28+
```
2829

30+
```output
2931
CurrentValue : 4
3032
Id : /subscriptions/9caf2a1e-9c49-49b6-89a2-56bdec7e3f97/providers/Microsoft.SignalRService/locations/eastus/usages/FreeTierInstances
3133
Limit : 5

src/SignalR/SignalR.Autorest/docs/New-AzWebPubSub.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@ Create or update a resource.
3131

3232
### Example 1: Create a Web PubSub resource with minimal required parameters.
3333
```powershell
34-
PS C:\> New-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps -Location eastus -SkuName Standard_S1
34+
New-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps -Location eastus -SkuName Standard_S1
35+
```
3536

37+
```output
3638
Name Location SkuName
3739
---- -------- -------
3840
psdemo-wps eastus Standard_S1
@@ -42,15 +44,15 @@ psdemo-wps eastus Standard_S1
4244

4345
### Example 2: Create a Web PubSub resource with more parameters and show the result
4446
```powershell
45-
PS C:\> $wps = New-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps `
47+
$wps = New-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps `
4648
-Location eastus -SkuName Standard_S1 -IdentityType SystemAssigned -LiveTraceEnabled true `
4749
-LiveTraceCategory @{ Name='ConnectivityLogs' ; Enabled = 'true' }, @{ Name='MessageLogs' ; Enabled = 'true' }
4850
4951
Name Location SkuName
5052
---- -------- -------
5153
psdemo-wps eastus Standard_S1
5254
53-
PS C:\> $wps | format-list
55+
$wps | format-list
5456
5557
DisableAadAuth : False
5658
DisableLocalAuth : False

src/SignalR/SignalR.Autorest/docs/New-AzWebPubSubHub.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,12 @@ Create or update a hub setting.
2525

2626
### Example 1: Create a hub setting
2727
```powershell
28-
PS C:\> $eventHandler = @{UrlTemplate = 'http://example.com/api/{hub}/connect/{event}' ; AuthType = 'None' ; SystemEvent = 'connect' ; }
28+
$eventHandler = @{UrlTemplate = 'http://example.com/api/{hub}/connect/{event}' ; AuthType = 'None' ; SystemEvent = 'connect' ; }
2929
30-
PS C:\> New-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps -EventHandler $eventHandler
30+
New-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps -EventHandler $eventHandler
31+
```
3132

33+
```output
3234
Name AnonymousConnectPolicy
3335
---- ----------------------
3436
testHub deny

src/SignalR/SignalR.Autorest/docs/New-AzWebPubSubKey.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,10 @@ PrimaryKey and SecondaryKey cannot be regenerated at the same time.
3434

3535
### Example 1: Regenerate the primary access key of a Web PubSub resource
3636
```powershell
37-
PS C:\> New-AzWebPubSubKey -ResourceGroupName psdemo -ResourceName psdemo-wps -KeyType 'Primary' | Format-List
37+
New-AzWebPubSubKey -ResourceGroupName psdemo -ResourceName psdemo-wps -KeyType 'Primary' | Format-List
38+
```
3839

40+
```output
3941
PrimaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0;
4042
PrimaryKey : ********
4143
SecondaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0;
@@ -46,9 +48,11 @@ SecondaryKey : ********
4648

4749
### Example 2: Regenerate the primary access key of a Web PubSub resource via identity
4850
```powershell
49-
PS C:\> $wps = Get-AzWebPubSub -Name psdemo-wps -ResourceGroupName psdemo
50-
PS C:\> $wps | New-AzWebPubSubKey -KeyType Primary | Format-List
51+
$wps = Get-AzWebPubSub -Name psdemo-wps -ResourceGroupName psdemo
52+
$wps | New-AzWebPubSubKey -KeyType Primary | Format-List
53+
```
5154

55+
```output
5256
PrimaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0;
5357
PrimaryKey : ********
5458
SecondaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0;

src/SignalR/SignalR.Autorest/docs/Remove-AzWebPubSub.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,18 @@ Operation to delete a resource.
3131

3232
### Example 1: Remove a Web PubSub resource
3333
```powershell
34-
PS C:\> Remove-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps
34+
Remove-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps
3535
```
3636

3737

3838

3939
### Example 2: Remove a Web PubSub resource via identity
4040
```powershell
41-
PS C:\> $identity = @{ResourceGroupName = 'psdemo'
41+
$identity = @{ResourceGroupName = 'psdemo'
4242
ResourceName = 'psdemo-wps'
4343
SubscriptionId = $(Get-AzContext).Subscription.Id }
4444
45-
PS C:\> $identity | Remove-AzWebPubSub
45+
$identity | Remove-AzWebPubSub
4646
```
4747

4848

src/SignalR/SignalR.Autorest/docs/Remove-AzWebPubSubHub.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,18 @@ Delete a hub setting.
3232

3333
### Example 1: Remove a hub setting.
3434
```powershell
35-
PS C:\> Remove-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps
35+
Remove-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps
3636
```
3737

3838

3939

4040
### Example 2: Remove a hub setting via identity.
4141
```powershell
42-
PS C:\> $hubIdentity = @{HubName = 'testHub'
42+
$hubIdentity = @{HubName = 'testHub'
4343
ResourceGroupName='psdemo'
4444
ResourceName = 'psdemo-wps'
4545
SubscriptionId = $(Get-AzContext).Subscription.Id}
46-
PS C:\> $hubIdentity | Remove-AzWebPubSubHub
46+
$hubIdentity | Remove-AzWebPubSubHub
4747
```
4848

4949
The example first constructs a hash table standing for the hub identity.

0 commit comments

Comments
 (0)