Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions src/SignalR/SignalR.Autorest/docs/Get-AzWebPubSub.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,10 @@ Get the resource and its properties.

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

```output
Name Location SkuName
---- -------- -------
demo1 eastus Standard_S1
Expand All @@ -53,8 +55,10 @@ demo2 eastus Free_F1

### Example 2: List all Web PubSub resources in a resource group
```powershell
PS C:\> Get-AzWebPubSub -ResourceGroupName psdemo
Get-AzWebPubSub -ResourceGroupName psdemo
```

```output
Name Location SkuName
---- -------- -------
psdemo-wps eastus Standard_S1
Expand All @@ -64,8 +68,10 @@ psdemo-wps eastus Standard_S1

### Example 3: Get a specific Web PubSub resource
```powershell
PS C:\> Get-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps
Get-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps
```

```output
Name Location SkuName
---- -------- -------
psdemo-wps eastus Standard_S1
Expand All @@ -75,12 +81,14 @@ psdemo-wps eastus Standard_S1

### Example 4: Get a specific Web PubSub resource via identity object
```powershell
PS C:\> $identity = @{ ResourceGroupName = 'psdemo'
$identity = @{ ResourceGroupName = 'psdemo'
ResourceName = 'psdemo-wps'
SubscriptionId = $(Get-AzContext).Subscription.Id }

PS C:\> $identity | Get-AzWebPubSub
$identity | Get-AzWebPubSub
```

```output
Name Location SkuName
---- -------- -------
psdemo-wps eastus Standard_S1
Expand Down
14 changes: 10 additions & 4 deletions src/SignalR/SignalR.Autorest/docs/Get-AzWebPubSubHub.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,10 @@ Get a hub setting.

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

```output
Name AnonymousConnectPolicy
---- ----------------------
testHub deny
Expand All @@ -48,8 +50,10 @@ testHub2 deny

### Example 2: Get a Web PubSub hub setting.
```powershell
PS C:\> Get-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps
Get-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps
```

```output
Name AnonymousConnectPolicy
---- ----------------------
testHub deny
Expand All @@ -59,12 +63,14 @@ testHub deny

### Example 3: Get a Web PubSub hub setting via identity.
```powershell
PS C:\> $hubIdentity = @{ ResourceGroupName = 'psdemo'
$hubIdentity = @{ ResourceGroupName = 'psdemo'
ResourceName = 'psdemo-wps'
SubscriptionId = $(Get-AzContext).Subscription.Id
HubName = 'testHub' }
PS C:\> $hubIdentity | Get-AzWebPubSubHub
$hubIdentity | Get-AzWebPubSubHub
```

```output
Name AnonymousConnectPolicy
---- ----------------------
testHub deny
Expand Down
10 changes: 7 additions & 3 deletions src/SignalR/SignalR.Autorest/docs/Get-AzWebPubSubKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ Get the access keys of the resource.

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

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

### Example 2: Get the access keys of a Web PubSub resource via identity
```powershell
PS C:\> $wps = Get-AzWebPubSub -ResourceGroupName psdemo -ResourceName psdemo-wps
PS C:\> $wps | Get-AzWebPubSubKey | Format-List
$wps = Get-AzWebPubSub -ResourceGroupName psdemo -ResourceName psdemo-wps
$wps | Get-AzWebPubSubKey | Format-List
```

```output
PrimaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0;
PrimaryKey : ********
SecondaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0;
Expand Down
4 changes: 3 additions & 1 deletion src/SignalR/SignalR.Autorest/docs/Get-AzWebPubSubSku.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ List all available skus of the resource.

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

```output
CapacityAllowedValue : {0, 1}
CapacityDefault : 1
CapacityMaximum : 1
Expand Down
4 changes: 3 additions & 1 deletion src/SignalR/SignalR.Autorest/docs/Get-AzWebPubSubUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ List resource usage quotas by location.

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

```output
CurrentValue : 4
Id : /subscriptions/9caf2a1e-9c49-49b6-89a2-56bdec7e3f97/providers/Microsoft.SignalRService/locations/eastus/usages/FreeTierInstances
Limit : 5
Expand Down
8 changes: 5 additions & 3 deletions src/SignalR/SignalR.Autorest/docs/New-AzWebPubSub.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ Create or update a resource.

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

```output
Name Location SkuName
---- -------- -------
psdemo-wps eastus Standard_S1
Expand All @@ -42,15 +44,15 @@ psdemo-wps eastus Standard_S1

### Example 2: Create a Web PubSub resource with more parameters and show the result
```powershell
PS C:\> $wps = New-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps `
$wps = New-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps `
-Location eastus -SkuName Standard_S1 -IdentityType SystemAssigned -LiveTraceEnabled true `
-LiveTraceCategory @{ Name='ConnectivityLogs' ; Enabled = 'true' }, @{ Name='MessageLogs' ; Enabled = 'true' }

Name Location SkuName
---- -------- -------
psdemo-wps eastus Standard_S1

PS C:\> $wps | format-list
$wps | format-list

DisableAadAuth : False
DisableLocalAuth : False
Expand Down
6 changes: 4 additions & 2 deletions src/SignalR/SignalR.Autorest/docs/New-AzWebPubSubHub.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@ Create or update a hub setting.

### Example 1: Create a hub setting
```powershell
PS C:\> $eventHandler = @{UrlTemplate = 'http://example.com/api/{hub}/connect/{event}' ; AuthType = 'None' ; SystemEvent = 'connect' ; }
$eventHandler = @{UrlTemplate = 'http://example.com/api/{hub}/connect/{event}' ; AuthType = 'None' ; SystemEvent = 'connect' ; }

PS C:\> New-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps -EventHandler $eventHandler
New-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps -EventHandler $eventHandler
```

```output
Name AnonymousConnectPolicy
---- ----------------------
testHub deny
Expand Down
10 changes: 7 additions & 3 deletions src/SignalR/SignalR.Autorest/docs/New-AzWebPubSubKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,10 @@ PrimaryKey and SecondaryKey cannot be regenerated at the same time.

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

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

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

```output
PrimaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0;
PrimaryKey : ********
SecondaryConnectionString : Endpoint=https://psdemo-wps.webpubsub.azure.com;AccessKey=********;Version=1.0;
Expand Down
6 changes: 3 additions & 3 deletions src/SignalR/SignalR.Autorest/docs/Remove-AzWebPubSub.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,18 @@ Operation to delete a resource.

### Example 1: Remove a Web PubSub resource
```powershell
PS C:\> Remove-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps
Remove-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps
```



### Example 2: Remove a Web PubSub resource via identity
```powershell
PS C:\> $identity = @{ResourceGroupName = 'psdemo'
$identity = @{ResourceGroupName = 'psdemo'
ResourceName = 'psdemo-wps'
SubscriptionId = $(Get-AzContext).Subscription.Id }

PS C:\> $identity | Remove-AzWebPubSub
$identity | Remove-AzWebPubSub
```


Expand Down
6 changes: 3 additions & 3 deletions src/SignalR/SignalR.Autorest/docs/Remove-AzWebPubSubHub.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,18 @@ Delete a hub setting.

### Example 1: Remove a hub setting.
```powershell
PS C:\> Remove-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps
Remove-AzWebPubSubHub -Name testHub -ResourceGroupName psdemo -ResourceName psdemo-wps
```



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

The example first constructs a hash table standing for the hub identity.
Expand Down
6 changes: 3 additions & 3 deletions src/SignalR/SignalR.Autorest/docs/Restart-AzWebPubSub.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,18 @@ Operation to restart a resource.

### Example 1: Restart a Web PubSub resource
```powershell
PS C:\> Restart-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps
Restart-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps
```



### Example 2: Restart a Web PubSub resource with identity
```powershell
PS C:\> $identity = @{ResourceGroupName = 'psdemo'
$identity = @{ResourceGroupName = 'psdemo'
ResourceName = 'psdemo-wps'
SubscriptionId = $(Get-AzContext).Subscription.Id }

PS C:\> $identity | Restart-AzWebPubSub
$identity | Restart-AzWebPubSub
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ Checks that the resource name is valid and is not already in use.

### Example 1: Check if the resource name "abc" is available in east US region.
```powershell
PS C:\> Test-AzWebPubSubNameAvailability -Location eastus -Name abc
Test-AzWebPubSubNameAvailability -Location eastus -Name abc
```

```output
NameAvailable Reason Message
------------- ------ -------
True
Expand Down
12 changes: 7 additions & 5 deletions src/SignalR/SignalR.Autorest/docs/Update-AzWebPubSub.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ Operation to update an exiting resource.

### Example 1: Update a Web PubSub resource
```powershell
PS C:\> $wps = Update-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps `
$wps = Update-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps `
-IdentityType SystemAssigned -LiveTraceEnabled true `
-LiveTraceCategory @{ Name='ConnectivityLogs' ; Enabled = 'true' }, @{ Name='MessageLogs' ; Enabled = 'true' }

Name Location SkuName
---- -------- -------
psdemo-wps eastus Standard_S1

PS C:\> $wps | format-list
$wps | format-list

DisableAadAuth : False
DisableLocalAuth : False
Expand All @@ -67,13 +67,15 @@ Version : 1.0

### Example 2: Update a Web PubSub resource via identity
```powershell
PS C:\> $identity = @{ ResourceGroupName = 'psdemo'
$identity = @{ ResourceGroupName = 'psdemo'
ResourceName = 'psdemo-wps'
SubscriptionId = $(Get-AzContext).Subscription.Id }
PS C:\> $identity | Update-AzWebPubSub -EnableTlsClientCert
$identity | Update-AzWebPubSub -EnableTlsClientCert

PS C:\> $wps | format-list
$wps | format-list
```

```output
DisableAadAuth : False
DisableLocalAuth : False
EnableTlsClientCert : True
Expand Down
18 changes: 13 additions & 5 deletions src/SignalR/SignalR.Autorest/examples/Get-AzWebPubSub.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
### Example 1: List all Web PubSub resources in a subscription
```powershell
PS C:\> Get-AzWebPubSub -SubscriptionId ef72249e-9785-4799-a76b-7cdd80e1b1d0
Get-AzWebPubSub -SubscriptionId ef72249e-9785-4799-a76b-7cdd80e1b1d0
```

```output
Name Location SkuName
---- -------- -------
demo1 eastus Standard_S1
Expand All @@ -12,8 +14,10 @@ demo2 eastus Free_F1

### Example 2: List all Web PubSub resources in a resource group
```powershell
PS C:\> Get-AzWebPubSub -ResourceGroupName psdemo
Get-AzWebPubSub -ResourceGroupName psdemo
```

```output
Name Location SkuName
---- -------- -------
psdemo-wps eastus Standard_S1
Expand All @@ -23,21 +27,25 @@ psdemo-wps eastus Standard_S1

### Example 3: Get a specific Web PubSub resource
```powershell
PS C:\> Get-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps
Get-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps
```

```output
Name Location SkuName
---- -------- -------
psdemo-wps eastus Standard_S1
```

### Example 4: Get a specific Web PubSub resource via identity object
```powershell
PS C:\> $identity = @{ ResourceGroupName = 'psdemo'
$identity = @{ ResourceGroupName = 'psdemo'
ResourceName = 'psdemo-wps'
SubscriptionId = $(Get-AzContext).Subscription.Id }

PS C:\> $identity | Get-AzWebPubSub
$identity | Get-AzWebPubSub
```

```output
Name Location SkuName
---- -------- -------
psdemo-wps eastus Standard_S1
Expand Down
Loading