Added description and synopsis for mysql cmdlets (#13626)

* Generate flexible server cmdlets (#13269)

* test commit with server mgmt md files

* cmdlet design draft

* fixed errors for mysql md files

* fixed errors for mysql md files

* fixing mistakes

* resolved comments

* mysql cmdlets customization verified

* mysql modified

* postgres customized cmdlets and readme

* mysql postgres customized cmdlets and docs

* initial commit for mysql pg module

* mysql test success

* pg module

* postgresql cmdlet update test fixed

* example document fixed

* Revert "example document fixed"

This reverts commit 6c60dbf.

* align single server test with flexible server

* docs fixed

* docs files moved from exports to upper folder

* typo fixed

* revert postgresql

* configuration fixed

* cred scan added

* cred scan issue resolved

* Regenerate doc of the MySql

* comments resolved

* synopsis and description added

* Fix MySql doc issues

* Revert examples/New-AzMySqlVirtualNetworkRule.md incorrect change
* Update doc/*.md

Co-authored-by: Jin Lei <[email protected]>
Co-authored-by: msJinLei <[email protected]>

Author: 3 people

src/MySql/custom/New-AzMySqlFlexibleServer.ps1

@@ -13,6 +13,12 @@
 # limitations under the License.
 # ----------------------------------------------------------------------------------
 
+<#
+.Synopsis
+Creates a new MySQL flexible server
+.Description
+Creates a new MySQL flexible server
+#>
 function New-AzMySqlFlexibleServer {
     [OutputType([Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Preview.IServerAutoGenerated])]
     [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')]

src/MySql/custom/New-AzMySqlFlexibleServerFirewallRule.ps1

@@ -15,9 +15,9 @@
 
 <#
 .Synopsis
-Creates a new firewall rule or updates an existing firewall rule.
+Creates a new firewall rule for MySQL flexible server
 .Description
-Creates a new firewall rule or updates an existing firewall rule.
+Creates a new firewall rule for MySQL flexible server
 #>
 function New-AzMySqlFlexibleServerFirewallRule {
 [OutputType([Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IFirewallRule])]

src/MySql/custom/New-AzMySqlFlexibleServerReplica.ps1

@@ -13,6 +13,13 @@
 # limitations under the License.
 # ----------------------------------------------------------------------------------
 
+<#
+.Synopsis
+Creates a replica server for a MySQL flexible server
+.Description
+Creates a replica server for a MySQL flexible server
+#>
+
 function New-AzMySqlFlexibleServerReplica {
     [OutputType([Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Preview.IServerAutoGenerated])]
     [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')]

src/MySql/custom/Update-AzMySqlFlexibleServer.ps1

@@ -13,10 +13,16 @@
 # limitations under the License.
 # ----------------------------------------------------------------------------------
 
+<#
+.Synopsis
+Updates an existing MySQL flexible server. The request body can contain one to many of the properties present in the normal server definition. Use Update-AzMySqlFlexibleServerConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count.
+.Description
+Updates an existing MySQL flexible server. The request body can contain one to many of the properties present in the normal server definition. Use Update-AzMySqlFlexibleServerConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count.
+#>
+
 function Update-AzMySqlFlexibleServer {
     [OutputType([Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Preview.IServerAutoGenerated])]
     [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')]
-    [Microsoft.Azure.PowerShell.Cmdlets.MySql.Description('Updates an existing server. The request body can contain one to many of the properties present in the normal server definition. Use Update-AzMySqlFlexibleServerConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count.')]
     param(
         [Parameter(ParameterSetName='UpdateExpanded', Mandatory, HelpMessage='The name of the server.')]
         [Alias('ServerName')]

src/MySql/custom/Update-AzMySqlFlexibleServerConfiguration.ps1

@@ -13,6 +13,13 @@
 # limitations under the License.
 # ----------------------------------------------------------------------------------
 
+<#
+.Synopsis
+Updates information about a configuration of a MySQL flexible server.
+.Description
+Updates information about a configuration of a MySQL flexible server.
+#>
+
 function Update-AzMySqlFlexibleServerConfiguration {
     [OutputType([Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Preview.IConfigurationAutoGenerated])]
     [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')]

src/MySql/custom/Update-AzMySqlFlexibleServerFirewallRule.ps1

@@ -15,9 +15,9 @@
 
 <#
 .Synopsis
-Creates a new firewall rule or updates an existing firewall rule.
+Updates an existing firewall rule.
 .Description
-Creates a new firewall rule or updates an existing firewall rule.
+Updates an existing firewall rule.
 #>
 function Update-AzMySqlFlexibleServerFirewallRule {
 [OutputType([Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IFirewallRule])]

src/MySql/docs/Az.MySql.md

@@ -1,6 +1,6 @@
 ---
 Module Name: Az.MySql
-Module Guid: fc8b3a19-b288-4f67-a4ff-b2d82a11cd6a
+Module Guid: 6fb456f8-3967-40b0-a0af-3be8e13ae017
 Download Help Link: https://docs.microsoft.com/en-us/powershell/module/az.mysql
 Help Version: 1.0.0.0
 Locale: en-US
@@ -54,7 +54,7 @@ Creates a new server.
 Creates a new database or updates an existing database.
 
 ### [New-AzMySqlFlexibleServerFirewallRule](New-AzMySqlFlexibleServerFirewallRule.md)
-Creates a new firewall rule or updates an existing firewall rule.
+Creates a new firewall rule for MySQL flexible server
 
 ### [New-AzMySqlFlexibleServerReplica](New-AzMySqlFlexibleServerReplica.md)
 Creates a new replica from an existing database.
@@ -112,18 +112,18 @@ Use Update-AzMySqlServer instead if you want update AdministratorLoginPassword,
 Creates a new firewall rule or updates an existing firewall rule.
 
 ### [Update-AzMySqlFlexibleServer](Update-AzMySqlFlexibleServer.md)
-Updates an existing server.
+Updates an existing MySQL flexible server.
 The request body can contain one to many of the properties present in the normal server definition.
-Use Update-AzMySqlConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count.
+Use Update-AzMySqlFlexibleServerConfiguration instead if you want update server parameters such as wait_timeout or net_retry_count.
 
 ### [Update-AzMySqlFlexibleServerConfiguration](Update-AzMySqlFlexibleServerConfiguration.md)
-
+Updates information about a configuration of a MySQL flexible server.
 
 ### [Update-AzMySqlFlexibleServerDatabase](Update-AzMySqlFlexibleServerDatabase.md)
 Creates a new database or updates an existing database.
 
 ### [Update-AzMySqlFlexibleServerFirewallRule](Update-AzMySqlFlexibleServerFirewallRule.md)
-Creates a new firewall rule or updates an existing firewall rule.
+Updates an existing firewall rule.
 
 ### [Update-AzMySqlServer](Update-AzMySqlServer.md)
 Updates an existing server.

src/MySql/docs/New-AzMySqlFlexibleServer.md

@@ -8,7 +8,7 @@ schema: 2.0.0
 # New-AzMySqlFlexibleServer
 
 ## SYNOPSIS
-Creates a new server.
+Creates a new MySQL flexible server
 
 ## SYNTAX
 

src/MySql/docs/New-AzMySqlFlexibleServerFirewallRule.md

@@ -8,7 +8,7 @@ schema: 2.0.0
 # New-AzMySqlFlexibleServerFirewallRule
 
 ## SYNOPSIS
-Creates a new firewall rule or updates an existing firewall rule.
+Creates a new firewall rule for MySQL flexible server
 
 ## SYNTAX
 
@@ -34,7 +34,7 @@ New-AzMySqlFlexibleServerFirewallRule -ResourceGroupName <String> -ServerName <S
 ```
 
 ## DESCRIPTION
-Creates a new firewall rule or updates an existing firewall rule.
+Creates a new firewall rule for MySQL flexible server
 
 ## EXAMPLES
 

src/MySql/docs/New-AzMySqlFlexibleServerReplica.md

@@ -8,7 +8,7 @@ schema: 2.0.0
 # New-AzMySqlFlexibleServerReplica
 
 ## SYNOPSIS
-Creates a new replica from an existing database.
+Creates a replica server for a MySQL flexible server
 
 ## SYNTAX