From 308085aaa9fb345f17291ccac5d52ac55994af01 Mon Sep 17 00:00:00 2001 From: Jin Lei <54836179+msJinLei@users.noreply.github.com> Date: Fri, 25 Sep 2020 01:11:16 +0800 Subject: [PATCH] Fix MariaDb document issues --- .../custom/Get-AzMariaDBConnectionString.ps1 | 7 +++++ src/MariaDb/custom/New-AzMariaDBServer.ps1 | 6 ++++ src/MariaDb/custom/New-AzMariaDbReplica.ps1 | 7 +++++ .../custom/Restart-AzMariaDbServer.ps1 | 7 +++++ .../custom/Restore-AzMariaDBServer.ps1 | 7 +++++ src/MariaDb/docs/Az.MariaDb.md | 10 +++---- .../docs/Get-AzMariaDbConnectionString.md | 7 +++-- src/MariaDb/docs/New-AzMariaDbReplica.md | 11 +++---- src/MariaDb/docs/Restart-AzMariaDbServer.md | 22 +++++++------- src/MariaDb/docs/Restore-AzMariaDbServer.md | 29 +++++++++++-------- 10 files changed, 78 insertions(+), 35 deletions(-) diff --git a/src/MariaDb/custom/Get-AzMariaDBConnectionString.ps1 b/src/MariaDb/custom/Get-AzMariaDBConnectionString.ps1 index 678f06da3d72..9eb0a4b3dc67 100644 --- a/src/MariaDb/custom/Get-AzMariaDBConnectionString.ps1 +++ b/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)] diff --git a/src/MariaDb/custom/New-AzMariaDBServer.ps1 b/src/MariaDb/custom/New-AzMariaDBServer.ps1 index f5839a4e61f5..7c9b3ee27883 100644 --- a/src/MariaDb/custom/New-AzMariaDBServer.ps1 +++ b/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')] diff --git a/src/MariaDb/custom/New-AzMariaDbReplica.ps1 b/src/MariaDb/custom/New-AzMariaDbReplica.ps1 index 8757b70d2195..57b3381dab8d 100644 --- a/src/MariaDb/custom/New-AzMariaDbReplica.ps1 +++ b/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')] diff --git a/src/MariaDb/custom/Restart-AzMariaDbServer.ps1 b/src/MariaDb/custom/Restart-AzMariaDbServer.ps1 index 41f4ef071a7e..3ffaddac04af 100644 --- a/src/MariaDb/custom/Restart-AzMariaDbServer.ps1 +++ b/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')] diff --git a/src/MariaDb/custom/Restore-AzMariaDBServer.ps1 b/src/MariaDb/custom/Restore-AzMariaDBServer.ps1 index 3201e6eff49b..1344d527b35f 100644 --- a/src/MariaDb/custom/Restore-AzMariaDBServer.ps1 +++ b/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])] diff --git a/src/MariaDb/docs/Az.MariaDb.md b/src/MariaDb/docs/Az.MariaDb.md index d99bf459f612..4be0841ecf1d 100644 --- a/src/MariaDb/docs/Az.MariaDb.md +++ b/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. diff --git a/src/MariaDb/docs/Get-AzMariaDbConnectionString.md b/src/MariaDb/docs/Get-AzMariaDbConnectionString.md index 0cb66fed59d1..5ac86f1f5a24 100644 --- a/src/MariaDb/docs/Get-AzMariaDbConnectionString.md +++ b/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 -InputObject [-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 diff --git a/src/MariaDb/docs/New-AzMariaDbReplica.md b/src/MariaDb/docs/New-AzMariaDbReplica.md index f8b735580206..9c4a9d09abe0 100644 --- a/src/MariaDb/docs/New-AzMariaDbReplica.md +++ b/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 -ReplicaName [-SubscriptionId [-DefaultProfile : +INPUTOBJECT : Identity Parameter - `[ConfigurationName ]`: The name of the server configuration. - `[DatabaseName ]`: The name of the database. - `[FirewallRuleName ]`: The name of the server firewall rule. diff --git a/src/MariaDb/docs/Restore-AzMariaDbServer.md b/src/MariaDb/docs/Restore-AzMariaDbServer.md index f91c7e00b2bb..a3bc9ea313b6 100644 --- a/src/MariaDb/docs/Restore-AzMariaDbServer.md +++ b/src/MariaDb/docs/Restore-AzMariaDbServer.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Restore-AzMariaDbServer ## SYNOPSIS - +Restore a MariaDb from a existing MariaDb. ## SYNTAX @@ -19,7 +19,7 @@ Restore-AzMariaDbServer -Name -RestorePointInTime [-InputObj ``` ## DESCRIPTION - +Restore a MariaDb from a existing MariaDb. ## EXAMPLES @@ -49,7 +49,7 @@ This command restore a PointInTime MariaDB by server object. ## PARAMETERS ### -AsJob - +Run the command as a job ```yaml Type: System.Management.Automation.SwitchParameter @@ -64,7 +64,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 @@ -79,6 +80,7 @@ Accept wildcard characters: False ``` ### -InputObject +The source server object to restore from. To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml @@ -109,7 +111,7 @@ Accept wildcard characters: False ``` ### -Name - +The dest server name to restore from. ```yaml Type: System.String @@ -124,7 +126,7 @@ Accept wildcard characters: False ``` ### -NoWait - +Run the command asynchronously ```yaml Type: System.Management.Automation.SwitchParameter @@ -139,7 +141,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 @@ -154,7 +157,8 @@ Accept wildcard characters: False ``` ### -RestorePointInTime - +region PointInTimeRestore + The location the resource resides in. ```yaml Type: System.DateTime @@ -169,7 +173,7 @@ Accept wildcard characters: False ``` ### -ServerName - +The source server name to restore from. ```yaml Type: System.String @@ -184,7 +188,8 @@ Accept wildcard characters: False ``` ### -SubscriptionId - +Gets the subscription Id which uniquely identifies the Microsoft Azure subscription. +The subscription ID is part of the URI for every service call. ```yaml Type: System.String @@ -199,7 +204,7 @@ Accept wildcard characters: False ``` ### -Tag - +Application-specific metadata in the form of key-value pairs. ```yaml Type: System.Collections.Hashtable @@ -264,7 +269,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 : +INPUTOBJECT : The source server object to restore from. - `Location `: The location the resource resides in. - `[Tag ]`: Application-specific metadata in the form of key-value pairs. - `[(Any) ]`: This indicates any property can be added to this object.