Add examples in documents and format SignalR resource output

Azure · Apr 19, 2018 · 6b4ef42 · 6b4ef42
1 parent 4042392
commit 6b4ef42
Show file tree

Hide file tree

Showing 9 changed files with 121 additions and 49 deletions.
diff --git a/src/ResourceManager/SignalR/Commands.SignalR/Cmdlets/NewAzureRmSignalR.cs b/src/ResourceManager/SignalR/Commands.SignalR/Cmdlets/NewAzureRmSignalR.cs
@@ -50,7 +50,7 @@ public sealed class NewAzureRmSignalR : SignalRCmdletBase
         [Parameter(
             Mandatory = false,
             Position = 2,
-            HelpMessage = "The SignalR service location.")]
+            HelpMessage = "The SignalR service location. The resource group location will be used if not specified.")]
         [LocationCompleter("Microsoft.SignalR/SignalR")]
         [ValidateNotNullOrEmpty()]
         public string Location { get; set; }

diff --git a/src/ResourceManager/SignalR/Commands.SignalR/Cmdlets/NewAzureRmSignalRKey.cs b/src/ResourceManager/SignalR/Commands.SignalR/Cmdlets/NewAzureRmSignalRKey.cs
@@ -10,7 +10,7 @@
 namespace Microsoft.Azure.Commands.SignalR
 {
     [Cmdlet(VerbsCommon.New, SignalRKeyNoun, SupportsShouldProcess = true, DefaultParameterSetName = ResourceGroupParameterSet)]
-    [OutputType(typeof(PSSignalRKeys))]
+    [OutputType(typeof(bool))]
     public class NewAzureRmSignalRKey : SignalRCmdletBase, IWithInputObject, IWithResourceId
     {
         [Parameter(Position = 0,
@@ -47,6 +47,9 @@ public class NewAzureRmSignalRKey : SignalRCmdletBase, IWithInputObject, IWithRe
         [ValidateSet("Primary", "Secondary", IgnoreCase = true)]
         public string KeyType { get; set; }
 
+        [Parameter(Mandatory = false)]
+        public SwitchParameter PassThru { get; set; }
+
         public override void ExecuteCmdlet()
         {
             base.ExecuteCmdlet();
@@ -70,8 +73,12 @@ public override void ExecuteCmdlet()
 
                 if (ShouldProcess($"{KeyType} key for {ResourceGroupName}/{Name}", "regenerate"))
                 {
-                    var keys = Client.Signalr.RegenerateKey(ResourceGroupName, Name, new RegenerateKeyParameters(KeyType));
-                    WriteObject(new PSSignalRKeys(Name, keys));
+                    Client.Signalr.RegenerateKey(ResourceGroupName, Name, new RegenerateKeyParameters(KeyType));
+
+                    if (PassThru)
+                    {
+                        WriteObject(true);
+                    }
                 }
             });
         }

diff --git a/src/ResourceManager/SignalR/Commands.SignalR/Cmdlets/RemoveAzureRmSignalR.cs b/src/ResourceManager/SignalR/Commands.SignalR/Cmdlets/RemoveAzureRmSignalR.cs
@@ -71,11 +71,11 @@ public override void ExecuteCmdlet()
                 if (ShouldProcess($"SignalR service {ResourceGroupName}/{Name}", "remove"))
                 {
                     Client.Signalr.Delete(ResourceGroupName, Name);
-                }
 
-                if (PassThru)
-                {
-                    WriteObject(true);
+                    if (PassThru)
+                    {
+                        WriteObject(true);
+                    }
                 }
             });
         }

diff --git a/src/ResourceManager/SignalR/Commands.SignalR/Microsoft.Azure.Commands.SignalR.format.ps1xml b/src/ResourceManager/SignalR/Commands.SignalR/Microsoft.Azure.Commands.SignalR.format.ps1xml
@@ -6,25 +6,16 @@
       <ViewSelectedBy>
         <TypeName>Microsoft.Azure.Commands.SignalR.Models.PSSignalRResource</TypeName>
       </ViewSelectedBy>
-      <GroupBy>
-        <ScriptBlock>$_.Location</ScriptBlock>
-        <Label>SignalR service location</Label>
-      </GroupBy>
       <TableControl>
         <TableHeaders>
           <TableColumnHeader>
-            <Label>Name</Label>
-            <Width>17</Width>
+            <Label>HostName</Label>
+            <Width>50</Width>
             <Alignment>Left</Alignment>
           </TableColumnHeader>
           <TableColumnHeader>
-            <Label>Sku</Label>
-            <Width>10</Width>
-            <Alignment>Left</Alignment>
-          </TableColumnHeader>
-          <TableColumnHeader>
-            <Label>HostName</Label>
-            <Width>25</Width>
+            <Label>Location</Label>
+            <Width>14</Width>
             <Alignment>Left</Alignment>
           </TableColumnHeader>
           <TableColumnHeader>
@@ -47,13 +38,10 @@
           <TableRowEntry>
             <TableColumnItems>
               <TableColumnItem>
-                <ScriptBlock>$_.Name</ScriptBlock>
-              </TableColumnItem>
-              <TableColumnItem>
-                <ScriptBlock>$_.Sku</ScriptBlock>
+                <ScriptBlock>$_.HostName</ScriptBlock>
               </TableColumnItem>
               <TableColumnItem>
-                <ScriptBlock>$_.HostName</ScriptBlock>
+                <ScriptBlock>$_.Location</ScriptBlock>
               </TableColumnItem>
               <TableColumnItem>
                 <ScriptBlock>$_.ServerPort</ScriptBlock>

diff --git a/src/ResourceManager/SignalR/Commands.SignalR/help/Get-AzureRmSignalR.md b/src/ResourceManager/SignalR/Commands.SignalR/help/Get-AzureRmSignalR.md
@@ -34,12 +34,49 @@ Get a specific SignalR service or all the SignalR services in a resource group o
 
 ## EXAMPLES
 
-### Example 1
+### Get all SignalR services in the subscription
 ```powershell
-PS C:\> {{ Add example code here }}
+PS C:\> Get-AzureRmSignalR
+
+HostName                                           Location       ServerPort PublicPort ProvisioningState
+--------                                           --------       ---------- ---------- -----------------
+mysignalr1.servicedev.signalr.net                  eastus         5002       5001       Succeeded
+mysignalr2.servicedev.signalr.net                  eastus         5002       5001       Succeeded
+mysignalr3.servicedev.signalr.net                  eastus         5002       5001       Creating
+```
+
+### Get all SignalR services in a resource group
+
+```powershell
+PS C:\> Get-AzureRmSignalR -ResourceGroupName myResourceGroup
+
+HostName                                           Location       ServerPort PublicPort ProvisioningState
+--------                                           --------       ---------- ---------- -----------------
+mysignalr1.servicedev.signalr.net                  eastus         5002       5001       Succeeded
+mysignalr2.servicedev.signalr.net                  eastus         5002       5001       Succeeded
+```
+
+### Get a specific SignalR service
+
+```powershell
+PS C:\> Get-AzureRmSignalR -ResourceGroupName myResourceGroup -Name mysignalr1
+
+HostName                                           Location       ServerPort PublicPort ProvisioningState
+--------                                           --------       ---------- ---------- -----------------
+mysignalr1.servicedev.signalr.net                  eastus         5002       5001       Succeeded
+```
+
+### Get a specific SignalR service from the default resource group
+
+```powershell
+PS C:\> Get-AzureRmSignalR -Name mysignalr2
+
+HostName                                           Location       ServerPort PublicPort ProvisioningState
+--------                                           --------       ---------- ---------- -----------------
+mysignalr2.servicedev.signalr.net                  eastus         5002       5001       Succeeded
 ```
 
-{{ Add example description here }}
+The default resource group can be set by `Set-AzureRmDefault -ResourceGroupName myResourceGroup`.
 
 ## PARAMETERS
 

diff --git a/src/ResourceManager/SignalR/Commands.SignalR/help/Get-AzureRmSignalRKey.md b/src/ResourceManager/SignalR/Commands.SignalR/help/Get-AzureRmSignalRKey.md
@@ -34,12 +34,24 @@ Get the access keys of a SignalR service.
 
 ## EXAMPLES
 
-### Example 1
+### Get access keys of a specific SignalR service
 ```powershell
-PS C:\> {{ Add example code here }}
+PS C:\> Get-AzureRmSignalRKey -ResourceGroupName myResourceGroup -Name mysignalr1
+
+Name       PrimaryKey                                   SecondaryKey
+----       ----------                                   ------------
+mysignalr1 vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmOQNt77PovDs= 2+HkuxAA34xiZFFiDsVM0uDyzCsg6GKsdXSjN4C/YFQ=
 ```
 
-{{ Add example description here }}
+### Get access keys from a SignalR service object in pipe
+
+```powershell
+PS C:\> Get-AzureRmSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 | Get-AzureRmSignalRKey
+
+Name       PrimaryKey                                   SecondaryKey
+----       ----------                                   ------------
+mysignalr1 vmYRhoM62PMkNe/CSSPdMSxokn+WZEFmOQNt77PovDs= 2+HkuxAA34xiZFFiDsVM0uDyzCsg6GKsdXSjN4C/YFQ=
+```
 
 ## PARAMETERS
 

diff --git a/src/ResourceManager/SignalR/Commands.SignalR/help/New-AzureRmSignalR.md b/src/ResourceManager/SignalR/Commands.SignalR/help/New-AzureRmSignalR.md
@@ -21,14 +21,22 @@ New-AzureRmSignalR [[-ResourceGroupName] <String>] [-Name] <String> [[-Location]
 ## DESCRIPTION
 Create a SignalR service.
 
+The following values will be used for the parameters if not specified:
+
+* `ResourceGroupName`: the default resource group set by `Set-AzureRmDefault -ResourceGroupName`.
+* `Location`: the location of the resource group
+* `Sku`: Basic_DS2
+
 ## EXAMPLES
 
-### Example 1
+### Create a SignalR serivce
 ```powershell
-PS C:\> {{ Add example code here }}
-```
+PS C:\> New-AzureRmSignalR -ResourceGroupName myResourceGroup1 -Name mysignalr1 -Location eastus -Sku Basic_DS2
 
-{{ Add example description here }}
+HostName                                           Location       ServerPort PublicPort ProvisioningState
+--------                                           --------       ---------- ---------- -----------------
+mysignalr1.servicedev.signalr.net                  eastus         5002       5001       Succeeded
+```
 
 ## PARAMETERS
 
@@ -63,7 +71,7 @@ Accept wildcard characters: False
 ```
 
 ### -Location
-The SignalR service location.
+The SignalR service location. The resource group location will be used if not specified.
 
 ```yaml
 Type: String

diff --git a/src/ResourceManager/SignalR/Commands.SignalR/help/New-AzureRmSignalRKey.md b/src/ResourceManager/SignalR/Commands.SignalR/help/New-AzureRmSignalRKey.md
@@ -14,19 +14,19 @@ Regenerate an access key for a SignalR service.
 
 ### ResourceGroupParameterSet (Default)
 ```
-New-AzureRmSignalRKey [[-ResourceGroupName] <String>] [-Name] <String> -KeyType <String>
+New-AzureRmSignalRKey [[-ResourceGroupName] <String>] [-Name] <String> -KeyType <String> [-PassThru]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### ResourceIdParameterSet
 ```
-New-AzureRmSignalRKey -ResourceId <String> -KeyType <String> [-DefaultProfile <IAzureContextContainer>]
- [-WhatIf] [-Confirm] [<CommonParameters>]
+New-AzureRmSignalRKey -ResourceId <String> -KeyType <String> [-PassThru]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### InputObjectParameterSet
 ```
-New-AzureRmSignalRKey -InputObject <PSSignalRResource> -KeyType <String>
+New-AzureRmSignalRKey -InputObject <PSSignalRResource> -KeyType <String> [-PassThru]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -35,12 +35,12 @@ Regenerate an access key for a SignalR service.
 
 ## EXAMPLES
 
-### Example 1
+### Regenerate the primary key
 ```powershell
-PS C:\> {{ Add example code here }}
-```
+PS C:\> New-AzureRmSignalRKey -ResourceGroupName myResourceGroup -Name mysignalr1 -KeyType Primary -PassThru
 
-{{ Add example description here }}
+True
+```
 
 ## PARAMETERS
 
@@ -105,6 +105,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -PassThru
+Returns true if the regeneration was completed successfully.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -ResourceGroupName
 Resource group name.
 

diff --git a/src/ResourceManager/SignalR/Commands.SignalR/help/Remove-AzureRmSignalR.md b/src/ResourceManager/SignalR/Commands.SignalR/help/Remove-AzureRmSignalR.md
@@ -35,12 +35,17 @@ Remove a SignalR service.
 
 ## EXAMPLES
 
-### Example 1
+### Remove a SignalR service
 ```powershell
-PS C:\> {{ Add example code here }}
+PS C:\> Remove-AzureRmSignalR -ResourceGroupName myResourceGroup -Name mysignalr1 -PassThru
+
+True
 ```
 
-{{ Add example description here }}
+### Remove all SignalR service from pipe
+```powershell
+PS C:\> Get-AzureRmSignalR -ResourceGroupName myResourceGroup | Remove-AzureRmSignalR
+```
 
 ## PARAMETERS
 
@@ -105,7 +110,7 @@ Accept wildcard characters: False
 ```
 
 ### -PassThru
-Returns true if removal was completed successfully.
+Returns true if the removal was completed successfully.
 
 ```yaml
 Type: SwitchParameter