Fix MariaDb document issues (Azure#13087)

Author: msJinLei

src/MariaDb/custom/Get-AzMariaDBConnectionString.ps1

@@ -12,6 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ----------------------------------------------------------------------------------
+
+<#
+.Synopsis
+Get connection string of a MariaDb under a given framework.
+.Description
+Get connection string of a MariaDb under a given framework.
+#>
 function Get-AzMariaDbConnectionString {
     [OutputType([System.String])]
     [CmdletBinding(DefaultParameterSetName='ServerName', PositionalBinding=$false)]

src/MariaDb/custom/New-AzMariaDBServer.ps1

@@ -11,6 +11,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ----------------------------------------------------------------------------------
+<#
+.Synopsis
+Creates a new MariaDb.
+.Description
+Creates a new MariaDb.
+#>
 function New-AzMariaDbServer {
     [OutputType([Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer])]
     [CmdletBinding(PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')]

src/MariaDb/custom/New-AzMariaDbReplica.ps1

@@ -11,6 +11,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ----------------------------------------------------------------------------------
+
+<#
+.Synopsis
+Creates a replica of a MariaDb server.
+.Description
+Creates a replica of a MariaDb server.
+#>
 function New-AzMariaDbReplica {
     [OutputType([Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer])]
     [CmdletBinding(DefaultParameterSetName='ServerName', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')]

src/MariaDb/custom/Restart-AzMariaDbServer.ps1

@@ -12,6 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ----------------------------------------------------------------------------------
+
+<#
+.Synopsis
+Restarts a server.
+.Description
+Restarts a server.
+#>
 function Restart-AzMariaDbServer {
     [OutputType([System.Boolean])]
     [CmdletBinding(DefaultParameterSetName='ServerName', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')]

src/MariaDb/custom/Restore-AzMariaDBServer.ps1

@@ -11,6 +11,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ----------------------------------------------------------------------------------
+
+<#
+.Synopsis
+Restore a MariaDb from a existing MariaDb.
+.Description
+Restore a MariaDb from a existing MariaDb.
+#>
 function Restore-AzMariaDbServer
 {
     [OutputType([Microsoft.Azure.PowerShell.Cmdlets.MariaDb.Models.Api20180601Preview.IServer])]

src/MariaDb/docs/Az.MariaDb.md

@@ -1,6 +1,6 @@
 ---
 Module Name: Az.MariaDb
-Module Guid: b40274bf-655e-4bbc-bfb2-90862175b6f2
+Module Guid: 8dbb10e2-0ec3-48c3-9481-1cb1e87e2368
 Download Help Link: https://docs.microsoft.com/en-us/powershell/module/az.mariadb
 Help Version: 1.0.0.0
 Locale: en-US
@@ -15,7 +15,7 @@ Microsoft Azure PowerShell: MariaDb cmdlets
 Gets information about a configuration of server.
 
 ### [Get-AzMariaDbConnectionString](Get-AzMariaDbConnectionString.md)
-
+Get connection string of a MariaDb under a given framework.
 
 ### [Get-AzMariaDbFirewallRule](Get-AzMariaDbFirewallRule.md)
 Gets information about a server firewall rule.
@@ -33,7 +33,7 @@ Gets a virtual network rule.
 Creates a new firewall rule or updates an existing firewall rule.
 
 ### [New-AzMariaDbReplica](New-AzMariaDbReplica.md)
-
+Creates a replica of a MariaDb server.
 
 ### [New-AzMariaDbServer](New-AzMariaDbServer.md)
 
@@ -51,10 +51,10 @@ Deletes a server.
 Deletes the virtual network rule with the given name.
 
 ### [Restart-AzMariaDbServer](Restart-AzMariaDbServer.md)
-
+Restarts a server.
 
 ### [Restore-AzMariaDbServer](Restore-AzMariaDbServer.md)
-
+Restore a MariaDb from a existing MariaDb.
 
 ### [Update-AzMariaDbConfiguration](Update-AzMariaDbConfiguration.md)
 Updates a configuration of a server.

src/MariaDb/docs/Get-AzMariaDbConnectionString.md

@@ -8,7 +8,7 @@ schema: 2.0.0
 # Get-AzMariaDbConnectionString
 
 ## SYNOPSIS
-
+Get connection string of a MariaDb under a given framework.
 
 ## SYNTAX
 
@@ -25,7 +25,7 @@ Get-AzMariaDbConnectionString -Client <String> -InputObject <IServer> [-DefaultP
 ```
 
 ## DESCRIPTION
-
+Get connection string of a MariaDb under a given framework.
 
 ## EXAMPLES
 
@@ -65,7 +65,8 @@ Accept wildcard characters: False
 ```
 
 ### -DefaultProfile
-
+region DefaultParameters
+ The credentials, account, tenant, and subscription used for communication with Azure.
 
 ```yaml
 Type: System.Management.Automation.PSObject

src/MariaDb/docs/New-AzMariaDbReplica.md

@@ -8,7 +8,7 @@ schema: 2.0.0
 # New-AzMariaDbReplica
 
 ## SYNOPSIS
-
+Creates a replica of a MariaDb server.
 
 ## SYNTAX
 
@@ -27,7 +27,7 @@ New-AzMariaDbReplica -Master <IServer> -ReplicaName <String> [-SubscriptionId <S
 ```
 
 ## DESCRIPTION
-
+Creates a replica of a MariaDb server.
 
 ## EXAMPLES
 
@@ -68,7 +68,7 @@ This command with parameter inputobject creates a replica db with parameter inpu
 ## PARAMETERS
 
 ### -AsJob
-
+Run the command as a job
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
@@ -83,7 +83,8 @@ Accept wildcard characters: False
 ```
 
 ### -DefaultProfile
-
+region DefaultParameters
+ The credentials, account, tenant, and subscription used for communication with Azure.
 
 ```yaml
 Type: System.Management.Automation.PSObject
@@ -144,7 +145,7 @@ Accept wildcard characters: False
 ```
 
 ### -NoWait
-
+Run the command asynchronously
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter

src/MariaDb/docs/Restart-AzMariaDbServer.md

@@ -8,7 +8,7 @@ schema: 2.0.0
 # Restart-AzMariaDbServer
 
 ## SYNOPSIS
-
+Restarts a server.
 
 ## SYNTAX
 
@@ -25,7 +25,7 @@ Restart-AzMariaDbServer -InputObject <IMariaDbIdentity> [-DefaultProfile <PSObje
 ```
 
 ## DESCRIPTION
-
+Restarts a server.
 
 ## EXAMPLES
 
@@ -48,7 +48,7 @@ This command restart a MariaDB.
 ## PARAMETERS
 
 ### -AsJob
-
+Run the command as a job
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
@@ -63,7 +63,7 @@ Accept wildcard characters: False
 ```
 
 ### -DefaultProfile
-
+The credentials, account, tenant, and subscription used for communication with Azure.
 
 ```yaml
 Type: System.Management.Automation.PSObject
@@ -78,6 +78,7 @@ Accept wildcard characters: False
 ```
 
 ### -InputObject
+Identity Parameter
 To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
 
 ```yaml
@@ -93,7 +94,7 @@ Accept wildcard characters: False
 ```
 
 ### -Name
-
+The name of the server.
 
 ```yaml
 Type: System.String
@@ -108,7 +109,7 @@ Accept wildcard characters: False
 ```
 
 ### -NoWait
-
+Run the command asynchronously
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
@@ -123,7 +124,7 @@ Accept wildcard characters: False
 ```
 
 ### -PassThru
-
+Returns true when the command succeeds
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
@@ -138,7 +139,8 @@ Accept wildcard characters: False
 ```
 
 ### -ResourceGroupName
-
+The name of the resource group that contains the resource.
+You can obtain this value from the Azure Resource Manager API or the portal.
 
 ```yaml
 Type: System.String
@@ -153,7 +155,7 @@ Accept wildcard characters: False
 ```
 
 ### -SubscriptionId
-
+The subscription ID that identifies an Azure subscription.
 
 ```yaml
 Type: System.String
@@ -218,7 +220,7 @@ COMPLEX PARAMETER PROPERTIES
 To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
 
 
-INPUTOBJECT <IMariaDbIdentity>: 
+INPUTOBJECT <IMariaDbIdentity>: Identity Parameter
   - `[ConfigurationName <String>]`: The name of the server configuration.
   - `[DatabaseName <String>]`: The name of the database.
   - `[FirewallRuleName <String>]`: The name of the server firewall rule.