Skip to content

Fix MariaDb document issues #13087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 27, 2020
Merged

Fix MariaDb document issues #13087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions src/MariaDb/custom/Get-AzMariaDBConnectionString.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

@isra-fel isra-fel Sep 27, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A small suggestion: we should use MariaDB in strings displayed to customer, because it's more formal. MariaDb should only be used internally. Otherwise it LGTM

Copy link
Contributor Author

@msJinLei msJinLei Sep 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A small suggestion: we should use MariaDB in strings displayed to customer, because it's more formal. MariaDb should only be used internally. Otherwise it LGTM

Your proposal make sense. However, currently we use MariaDb as the term of MariaDB in the Azure PowerShell

https://docs.microsoft.com/en-us/powershell/module/az.mariadb/?view=azps-4.7.0
https://docs.microsoft.com/en-us/powershell/module/az.mariadb/get-azmariadbconnectionstring?view=azps-4.7.0

We should change all of them to keep consistency.
Can you keep the current "MariaDb" temporarily?

Copy link
Member

@isra-fel isra-fel Sep 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed, I will merge this PR and move the discussion for naming in another issue.

.Description
Get connection string of a MariaDb under a given framework.
#>
function Get-AzMariaDbConnectionString {
[OutputType([System.String])]
[CmdletBinding(DefaultParameterSetName='ServerName', PositionalBinding=$false)]
Expand Down
6 changes: 6 additions & 0 deletions src/MariaDb/custom/New-AzMariaDBServer.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')]
Expand Down
7 changes: 7 additions & 0 deletions src/MariaDb/custom/New-AzMariaDbReplica.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')]
Expand Down
7 changes: 7 additions & 0 deletions src/MariaDb/custom/Restart-AzMariaDbServer.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')]
Expand Down
7 changes: 7 additions & 0 deletions src/MariaDb/custom/Restore-AzMariaDBServer.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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])]
Expand Down
10 changes: 5 additions & 5 deletions src/MariaDb/docs/Az.MariaDb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
Expand All @@ -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)

Expand All @@ -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.
Expand Down
7 changes: 4 additions & 3 deletions src/MariaDb/docs/Get-AzMariaDbConnectionString.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-AzMariaDbConnectionString

## SYNOPSIS

Get connection string of a MariaDb under a given framework.

## SYNTAX

Expand All @@ -25,7 +25,7 @@ Get-AzMariaDbConnectionString -Client <String> -InputObject <IServer> [-DefaultP
```

## DESCRIPTION

Get connection string of a MariaDb under a given framework.

## EXAMPLES

Expand Down Expand Up @@ -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
Expand Down
11 changes: 6 additions & 5 deletions src/MariaDb/docs/New-AzMariaDbReplica.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-AzMariaDbReplica

## SYNOPSIS

Creates a replica of a MariaDb server.

## SYNTAX

Expand All @@ -27,7 +27,7 @@ New-AzMariaDbReplica -Master <IServer> -ReplicaName <String> [-SubscriptionId <S
```

## DESCRIPTION

Creates a replica of a MariaDb server.

## EXAMPLES

Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -144,7 +145,7 @@ Accept wildcard characters: False
```

### -NoWait

Run the command asynchronously

```yaml
Type: System.Management.Automation.SwitchParameter
Expand Down
22 changes: 12 additions & 10 deletions src/MariaDb/docs/Restart-AzMariaDbServer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Restart-AzMariaDbServer

## SYNOPSIS

Restarts a server.

## SYNTAX

Expand All @@ -25,7 +25,7 @@ Restart-AzMariaDbServer -InputObject <IMariaDbIdentity> [-DefaultProfile <PSObje
```

## DESCRIPTION

Restarts a server.

## EXAMPLES

Expand All @@ -48,7 +48,7 @@ This command restart a MariaDB.
## PARAMETERS

### -AsJob

Run the command as a job

```yaml
Type: System.Management.Automation.SwitchParameter
Expand All @@ -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
Expand All @@ -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
Expand All @@ -93,7 +94,7 @@ Accept wildcard characters: False
```

### -Name

The name of the server.

```yaml
Type: System.String
Expand All @@ -108,7 +109,7 @@ Accept wildcard characters: False
```

### -NoWait

Run the command asynchronously

```yaml
Type: System.Management.Automation.SwitchParameter
Expand All @@ -123,7 +124,7 @@ Accept wildcard characters: False
```

### -PassThru

Returns true when the command succeeds

```yaml
Type: System.Management.Automation.SwitchParameter
Expand All @@ -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
Expand All @@ -153,7 +155,7 @@ Accept wildcard characters: False
```

### -SubscriptionId

The subscription ID that identifies an Azure subscription.

```yaml
Type: System.String
Expand Down Expand Up @@ -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.
Expand Down
Loading