Skip to content

Commit 6b175f8

Browse files
jaredmoojaredmoo
committed
Fixed markdown syntax error in remove database from failover group
1 parent abae7ea commit 6b175f8

File tree

2 files changed

+45
-57
lines changed

2 files changed

+45
-57
lines changed

‎src/ResourceManager/Sql/Commands.Sql/Microsoft.Azure.Commands.Sql.dll-Help.xml

Lines changed: 41 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -14656,68 +14656,59 @@ FirewallRuleName : Rule01</dev:code>
1465614656
<command:relatedLinks></command:relatedLinks>
1465714657
</command:command>
1465814658
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
14659-
<command:details><command:name>Remove-AzureRmSqlDatabaseFailoverGroup</command:name>
14659+
<command:details><command:name>Remove-AzureRmSqlDatabaseFromFailoverGroup</command:name>
1466014660
<command:verb>Remove</command:verb>
14661-
<command:noun>AzureRmSqlDatabaseFailoverGroup</command:noun>
14662-
<maml:description><maml:para>The Cmdlet that removes the Azure SQL Failover Group
14661+
<command:noun>AzureRmSqlDatabaseFromFailoverGroup</command:noun>
14662+
<maml:description><maml:para>The Cmdlet that drops databases from the Azure SQL Failover Group.
1466314663
</maml:para>
1466414664
</maml:description>
1466514665
</command:details>
14666-
<maml:description><maml:para>This command deletes all secondary databases included the FG and removes the FG object with the specified name from each participating server. The primary databases will become regular read-write databases. The listener endpoint will be unregistered from DNS.
14667-
14666+
<maml:description><maml:para>This command must be executed on the primary server. The command drops the corresponding secondary databases on all secondary servers and unregisters the read-write databases from the FG. The database input parameter is a Azure Sql Database Model and it should be either piped in or passed in as a environmental variable.
1466814667
</maml:para>
1466914668
</maml:description>
14670-
<command:syntax><command:syntaxItem><maml:name>Remove-AzureRmSqlDatabaseFailoverGroup</maml:name>
14671-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name>
14672-
<maml:Description><maml:para>The name of the resource group.
14669+
<command:syntax><command:syntaxItem><maml:name>Remove-AzureRmSqlDatabaseFromFailoverGroup</maml:name>
14670+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Databases</maml:name>
14671+
<maml:Description><maml:para>The Azure SQL Databases to be added to the secondary server.
1467314672
</maml:para>
1467414673
</maml:Description>
14675-
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
14676-
<dev:type><maml:name>String</maml:name>
14674+
<command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel]</command:parameterValue>
14675+
<dev:type><maml:name>System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel]</maml:name>
1467714676
<maml:uri /></dev:type>
1467814677
<dev:defaultValue>None</dev:defaultValue>
1467914678
</command:parameter>
14680-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>ServerName</maml:name>
14681-
<maml:Description><maml:para>The name of the Azure SQL Server the Failover Group is in.
14679+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>FailoverGroupName</maml:name>
14680+
<maml:Description><maml:para>The name of the Azure SQL Failover Group.
1468214681
</maml:para>
1468314682
</maml:Description>
1468414683
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
1468514684
<dev:type><maml:name>String</maml:name>
1468614685
<maml:uri /></dev:type>
1468714686
<dev:defaultValue>None</dev:defaultValue>
1468814687
</command:parameter>
14689-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>FailoverGroupName</maml:name>
14690-
<maml:Description><maml:para>The name of the Azure SQL Failover Group to remove.
14688+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name>
14689+
<maml:Description><maml:para>The name of the resource group.
1469114690
</maml:para>
1469214691
</maml:Description>
1469314692
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
1469414693
<dev:type><maml:name>String</maml:name>
1469514694
<maml:uri /></dev:type>
1469614695
<dev:defaultValue>None</dev:defaultValue>
1469714696
</command:parameter>
14698-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name>
14699-
<maml:Description><maml:para>Skip confirmation message for performing the action
14700-
</maml:para>
14701-
</maml:Description>
14702-
<dev:type><maml:name>SwitchParameter</maml:name>
14703-
<maml:uri /></dev:type>
14704-
<dev:defaultValue>False</dev:defaultValue>
14705-
</command:parameter>
14706-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PartnerResourceGroupName</maml:name>
14707-
<maml:Description><maml:para>The partner resource group name for Azure SQL Database Failover Group.
14697+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServerName</maml:name>
14698+
<maml:Description><maml:para>The name of the Azure SQL Server the Failover Group is in.
1470814699
</maml:para>
1470914700
</maml:Description>
1471014701
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
1471114702
<dev:type><maml:name>String</maml:name>
1471214703
<maml:uri /></dev:type>
1471314704
<dev:defaultValue>None</dev:defaultValue>
1471414705
</command:parameter>
14715-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PartnerServerName</maml:name>
14716-
<maml:Description><maml:para>The partner server name for Azure SQL Database Failover Group.
14706+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Tag"><maml:name>Tags</maml:name>
14707+
<maml:Description><maml:para>The tag to associate with the Azure Sql Elastic Pool
1471714708
</maml:para>
1471814709
</maml:Description>
14719-
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
14720-
<dev:type><maml:name>String</maml:name>
14710+
<command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue>
14711+
<dev:type><maml:name>Hashtable</maml:name>
1472114712
<maml:uri /></dev:type>
1472214713
<dev:defaultValue>None</dev:defaultValue>
1472314714
</command:parameter>
@@ -14739,57 +14730,48 @@ FirewallRuleName : Rule01</dev:code>
1473914730
</command:parameter>
1474014731
</command:syntaxItem>
1474114732
</command:syntax>
14742-
<command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>FailoverGroupName</maml:name>
14743-
<maml:Description><maml:para>The name of the Azure SQL Failover Group to remove.
14733+
<command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Databases</maml:name>
14734+
<maml:Description><maml:para>The Azure SQL Databases to be added to the secondary server.
1474414735
</maml:para>
1474514736
</maml:Description>
14746-
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
14747-
<dev:type><maml:name>String</maml:name>
14737+
<command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel]</command:parameterValue>
14738+
<dev:type><maml:name>System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel]</maml:name>
1474814739
<maml:uri /></dev:type>
1474914740
<dev:defaultValue>None</dev:defaultValue>
1475014741
</command:parameter>
14751-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Force</maml:name>
14752-
<maml:Description><maml:para>Skip confirmation message for performing the action
14753-
</maml:para>
14754-
</maml:Description>
14755-
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
14756-
<dev:type><maml:name>SwitchParameter</maml:name>
14757-
<maml:uri /></dev:type>
14758-
<dev:defaultValue>False</dev:defaultValue>
14759-
</command:parameter>
14760-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PartnerResourceGroupName</maml:name>
14761-
<maml:Description><maml:para>The partner resource group name for Azure SQL Database Failover Group.
14742+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>FailoverGroupName</maml:name>
14743+
<maml:Description><maml:para>The name of the Azure SQL Failover Group.
1476214744
</maml:para>
1476314745
</maml:Description>
1476414746
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
1476514747
<dev:type><maml:name>String</maml:name>
1476614748
<maml:uri /></dev:type>
1476714749
<dev:defaultValue>None</dev:defaultValue>
1476814750
</command:parameter>
14769-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PartnerServerName</maml:name>
14770-
<maml:Description><maml:para>The partner server name for Azure SQL Database Failover Group.
14751+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name>
14752+
<maml:Description><maml:para>The name of the resource group.
1477114753
</maml:para>
1477214754
</maml:Description>
1477314755
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
1477414756
<dev:type><maml:name>String</maml:name>
1477514757
<maml:uri /></dev:type>
1477614758
<dev:defaultValue>None</dev:defaultValue>
1477714759
</command:parameter>
14778-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name>
14779-
<maml:Description><maml:para>The name of the resource group.
14760+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServerName</maml:name>
14761+
<maml:Description><maml:para>The name of the Azure SQL Server the Failover Group is in.
1478014762
</maml:para>
1478114763
</maml:Description>
1478214764
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
1478314765
<dev:type><maml:name>String</maml:name>
1478414766
<maml:uri /></dev:type>
1478514767
<dev:defaultValue>None</dev:defaultValue>
1478614768
</command:parameter>
14787-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>ServerName</maml:name>
14788-
<maml:Description><maml:para>The name of the Azure SQL Server the Failover Group is in.
14769+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Tag"><maml:name>Tags</maml:name>
14770+
<maml:Description><maml:para>The tag to associate with the Azure Sql Elastic Pool
1478914771
</maml:para>
1479014772
</maml:Description>
14791-
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
14792-
<dev:type><maml:name>String</maml:name>
14773+
<command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue>
14774+
<dev:type><maml:name>Hashtable</maml:name>
1479314775
<maml:uri /></dev:type>
1479414776
<dev:defaultValue>None</dev:defaultValue>
1479514777
</command:parameter>
@@ -14814,7 +14796,7 @@ FirewallRuleName : Rule01</dev:code>
1481414796
</command:parameters>
1481514797
<command:inputTypes><command:inputType><dev:type><maml:name>System.String</maml:name>
1481614798
</dev:type>
14817-
<maml:description><maml:para>
14799+
<maml:description><maml:para>System.Collections.Generic.List`1[[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel, Microsoft.Azure.Commands.Sql, Version=2.5.0.0, Culture=neutral, PublicKeyToken=null]]
1481814800
</maml:para>
1481914801
</maml:description>
1482014802
</command:inputType>
@@ -14831,7 +14813,13 @@ FirewallRuleName : Rule01</dev:code>
1483114813
</maml:alert>
1483214814
</maml:alertSet>
1483314815
<command:examples><command:example><maml:title>Example 1</maml:title>
14834-
<dev:code>PS C:\&gt; PS C:\&gt; Remove-AzureRmSqlDatabaseFailoverGroup -PrimaryResourceGroupName "myFG" -ServerName "myserver" -FailoverGroupName "myFG"</dev:code>
14816+
<dev:code>PS C:\&gt; Get-AzureRmSqlDatabase -ServerName testsvr -ResourceGroupName myrg2 -DatabaseName testdb | Remove-AzureRmSqlDatabaseFromFailoverGroup -FailoverGroupName testfg -ResourceGroupName rg2 -ServerName testsvr</dev:code>
14817+
<dev:remarks><maml:para>
14818+
</maml:para>
14819+
</dev:remarks>
14820+
</command:example>
14821+
<command:example><maml:title>Example 2:</maml:title>
14822+
<dev:code>PS C:\&gt; Get-AzureRmSqlDatabase -ServerName testsvr -ResourceGroupName myrg2 | Remove-AzureRmSqlDatabaseFromFailoverGroup -FailoverGroupName testfg -ResourceGroupName rg2 -ServerName testsvr</dev:code>
1483514823
<dev:remarks><maml:para>
1483614824
</maml:para>
1483714825
</dev:remarks>

‎src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseFromFailoverGroup.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,18 @@ This command must be executed on the primary server. The command drops the corre
2424
## EXAMPLES
2525

2626
### Example 1
27-
```
2827
Remove one database from the Failover Group
2928

29+
```
3030
PS C:\> Get-AzureRmSqlDatabase -ServerName testsvr -ResourceGroupName myrg2 -DatabaseName testdb | Remove-AzureRmSqlDatabaseFromFailoverGroup -FailoverGroupName testfg -ResourceGroupName rg2 -ServerName testsvr
3131
```
3232

33-
### Example 2
34-
```
33+
### Example 2:
3534
Remove all databases in a server from the Failover Group
3635

36+
```
3737
PS C:\> Get-AzureRmSqlDatabase -ServerName testsvr -ResourceGroupName myrg2 | Remove-AzureRmSqlDatabaseFromFailoverGroup -FailoverGroupName testfg -ResourceGroupName rg2 -ServerName testsvr
38-
38+
```
3939

4040
## PARAMETERS
4141

0 commit comments

Comments
 (0)