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
17 changes: 12 additions & 5 deletions src/SignalR/SignalR/help/Get-AzSignalR.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,11 @@ Get a specific SignalR service or all the SignalR services in a resource group o
## EXAMPLES

### Get all SignalR services in the subscription
```powershell
Get-AzSignalR
```
PS C:\> Get-AzSignalR


```output
HostName Location ServerPort PublicPort ProvisioningState Version
-------- -------- ---------- ---------- ----------------- -------
mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0
Expand All @@ -46,28 +47,34 @@ mysignalr3.service.signalr.net eastus 5002 500
```

### Get all SignalR services in a resource group
```powershell
Get-AzSignalR -ResourceGroupName myResourceGroup
```
PS C:\> Get-AzSignalR -ResourceGroupName myResourceGroup

```output
HostName Location ServerPort PublicPort ProvisioningState Version
-------- -------- ---------- ---------- ----------------- -------
mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0
mysignalr2.service.signalr.net eastus 5002 5001 Succeeded 1.0
```

### Get a specific SignalR service
```powershell
Get-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1
```
PS C:\> Get-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1

```output
HostName Location ServerPort PublicPort ProvisioningState Version
-------- -------- ---------- ---------- ----------------- -------
mysignalr1.service.signalr.net eastus 5002 5001 Succeeded 1.0
```

### Get a specific SignalR service from the default resource group
```powershell
Get-AzSignalR -Name mysignalr2
```
PS C:\> Get-AzSignalR -Name mysignalr2

```output
HostName Location ServerPort PublicPort ProvisioningState Version
-------- -------- ---------- ---------- ----------------- -------
mysignalr2.service.signalr.net eastus 5002 5001 Succeeded 1.0
Expand Down
8 changes: 6 additions & 2 deletions src/SignalR/SignalR/help/Get-AzSignalRKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,10 @@ Get the access keys of a SignalR service.

### Get access keys of a specific SignalR service
```powershell
PS C:\> Get-AzSignalRKey -ResourceGroupName myResourceGroup -Name mysignalr1
Get-AzSignalRKey -ResourceGroupName myResourceGroup -Name mysignalr1
```

```output
Name : mysignalr1
PrimaryKey : vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmOQNt77PovDs=
PrimaryConnectionString : Endpoint=https://mysignalr1.service.signalr.net;AccessKey=vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmO
Expand All @@ -50,8 +52,10 @@ SecondaryConnectionString : Endpoint=https://mysignalr1.service.signalr.net;Acce
### Get access keys from a SignalR service object in pipe

```powershell
PS C:\> Get-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 | Get-AzSignalRKey
Get-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 | Get-AzSignalRKey
```

```output
Name : mysignalr1
PrimaryKey : vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmOQNt77PovDs=
PrimaryConnectionString : Endpoint=https://mysignalr1.service.signalr.net;AccessKey=vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmO
Expand Down
4 changes: 3 additions & 1 deletion src/SignalR/SignalR/help/Get-AzSignalRUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ Get the usage quota of a subscription.

### Get the usage quota by inputting the location
```powershell
PS C:\> Get-AzSignalRUsage eastus
Get-AzSignalRUsage eastus
```

```output
Name CurrentValue Limit
---- ------------ -----
FreeTierInstances 2 5
Expand Down
18 changes: 13 additions & 5 deletions src/SignalR/SignalR/help/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/help/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/help/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/help/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/help/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: 6 additions & 2 deletions src/SignalR/SignalR/help/New-AzSignalR.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,21 @@ The following values will be used for the parameters if not specified:

### Create a SignalR service
```powershell
PS C:\> New-AzSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr1 -Location eastus -Sku Standard_S1 -UnitCount 5
New-AzSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr1 -Location eastus -Sku Standard_S1 -UnitCount 5
```

```output
HostName Location ExternalIp Sku UnitCount ProvisioningState Version
-------- -------- ---------- --- --------- ----------------- -------
mysignalr1.service.signalr.net eastus 52.179.3.5 Standard_S1 5 Succeeded 1.0
```

### Specify ServiceMode and AllowedOrigin
```powershell
PS C:\> New-AzSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr2 -Location eastus -ServiceMode Serverless -AllowedOrigin http://example1.com:12345, https://example2.cn
New-AzSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr2 -Location eastus -ServiceMode Serverless -AllowedOrigin http://example1.com:12345, https://example2.cn
```

```output
HostName Location ExternalIp Sku UnitCount ProvisioningState Version
-------- -------- ---------- --- --------- ----------------- -------
mysignalr1.service.signalr.net eastus 52.179.3.5 Standard_S1 1 Succeeded 1.0
Expand Down
4 changes: 3 additions & 1 deletion src/SignalR/SignalR/help/New-AzSignalRKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ Regenerate an access key for a SignalR service.

### Regenerate the primary key
```powershell
PS C:\> New-AzSignalRKey -ResourceGroupName myResourceGroup -Name mysignalr1 -KeyType Primary -PassThru
New-AzSignalRKey -ResourceGroupName myResourceGroup -Name mysignalr1 -KeyType Primary -PassThru
```

```output
True
```

Expand Down
8 changes: 5 additions & 3 deletions src/SignalR/SignalR/help/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/help/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/help/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
8 changes: 5 additions & 3 deletions src/SignalR/SignalR/help/Remove-AzSignalR.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,17 @@ Remove a SignalR service.
## EXAMPLES

### Remove a SignalR service
```powershell
Remove-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -PassThru
```
PS C:\> Remove-AzSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -PassThru

```output
True
```

### Remove all SignalR service from pipe
```
PS C:\> Get-AzSignalR -ResourceGroupName myResourceGroup | Remove-AzSignalR
```powershell
Get-AzSignalR -ResourceGroupName myResourceGroup | Remove-AzSignalR
```

## PARAMETERS
Expand Down
6 changes: 3 additions & 3 deletions src/SignalR/SignalR/help/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
Loading