Skip to content

Commit 5b463c8

Browse files
committed
more help fixes
1 parent eb45a74 commit 5b463c8

8 files changed

+194
-100
lines changed

src/Sql/Sql/help/Az.Sql.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ Adds a Key Vault key to a SQL server.
3232
### [Add-AzSqlServerTransparentDataEncryptionCertificate](Add-AzSqlServerTransparentDataEncryptionCertificate.md)
3333
Adds a Transparent Data Encryption Certificate for the given SQL Server instance
3434

35+
### [Clear-AzSqlDatabaseAdvancedThreatProtectionSetting](Clear-AzSqlDatabaseAdvancedThreatProtectionSetting.md)
36+
Removes the advanced threat protection settings from a database.
37+
3538
### [Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline](Clear-AzSqlDatabaseVulnerabilityAssessmentRuleBaseline.md)
3639
Clears the vulnerability assessment rule baseline.
3740

@@ -47,7 +50,7 @@ Clears the vulnerability assessment settings of a managed database.
4750
### [Clear-AzSqlInstanceVulnerabilityAssessmentSetting](Clear-AzSqlInstanceVulnerabilityAssessmentSetting.md)
4851
Clears the vulnerability assessment settings of a managed instance.
4952

50-
### [Clear-AzSqlServerAdvancedThreatProtectionSettings](Clear-AzSqlServerAdvancedThreatProtectionSettings.md)
53+
### [Clear-AzSqlServerAdvancedThreatProtectionSetting](Clear-AzSqlServerAdvancedThreatProtectionSetting.md)
5154
Removes the advanced threat protection settings from a server.
5255

5356
### [Clear-AzSqlServerVulnerabilityAssessmentSetting](Clear-AzSqlServerVulnerabilityAssessmentSetting.md)
@@ -86,7 +89,7 @@ Gets one or more databases.
8689
### [Get-AzSqlDatabaseActivity](Get-AzSqlDatabaseActivity.md)
8790
Gets the status of database operations.
8891

89-
### [Get-AzSqlDatabaseAdvancedThreatProtectionSettings](Get-AzSqlDatabaseAdvancedThreatProtectionSettings.md)
92+
### [Get-AzSqlDatabaseAdvancedThreatProtectionSetting](Get-AzSqlDatabaseAdvancedThreatProtectionSetting.md)
9093
Gets the advanced threat protection settings for a database.
9194

9295
### [Get-AzSqlDatabaseAdvisor](Get-AzSqlDatabaseAdvisor.md)
@@ -273,15 +276,9 @@ Returns information about SQL Database servers.
273276
### [Get-AzSqlServerActiveDirectoryAdministrator](Get-AzSqlServerActiveDirectoryAdministrator.md)
274277
Gets information about an Azure AD administrator for SQL Server.
275278

276-
### [Get-AzSqlServerAdvancedDataSecurityPolicy](Get-AzSqlServerAdvancedDataSecurityPolicy.md)
277-
Gets Advanced Data Security policy of a server.
278-
279-
### [Get-AzSqlServerAdvancedThreatProtectionPolicy](Get-AzSqlServerAdvancedThreatProtectionPolicy.md)
279+
### [Get-AzSqlServerAdvancedThreatProtectionSetting](Get-AzSqlServerAdvancedThreatProtectionSetting.md)
280280
Gets Advanced Threat Protection policy of a server.
281281

282-
### [Get-AzSqlServerAdvancedThreatProtectionSettings](Get-AzSqlServerAdvancedThreatProtectionSettings.md)
283-
Gets the advanced threat protection settings for a server.
284-
285282
### [Get-AzSqlServerAdvisor](Get-AzSqlServerAdvisor.md)
286283
Gets one or more Advisors for an Azure SQL Server.
287284

@@ -714,9 +711,6 @@ Executes a failover of an Azure SQL Database Failover Group.
714711
### [Switch-AzSqlDatabaseInstanceFailoverGroup](Switch-AzSqlDatabaseInstanceFailoverGroup.md)
715712
Executes a failover of an Instance Failover Group.
716713

717-
### [Update-AzSqlDatabaseAdvancedThreatProtectionSettings](Update-AzSqlDatabaseAdvancedThreatProtectionSettings.md)
718-
Sets a advanced threat protection settings on a database.
719-
720714
### [Update-AzSqlDatabaseVulnerabilityAssessmentSetting](Update-AzSqlDatabaseVulnerabilityAssessmentSetting.md)
721715
Updates the vulnerability assessment settings of a database.
722716

@@ -726,7 +720,7 @@ Updates the vulnerability assessment settings of a managed database.
726720
### [Update-AzSqlInstanceVulnerabilityAssessmentSetting](Update-AzSqlInstanceVulnerabilityAssessmentSetting.md)
727721
Updates the vulnerability assessment settings of a managed instance.
728722

729-
### [Update-AzSqlServerAdvancedThreatProtectionSettings](Update-AzSqlServerAdvancedThreatProtectionSettings.md)
723+
### [Update-AzSqlServerAdvancedThreatProtectionSetting](Update-AzSqlServerAdvancedThreatProtectionSetting.md)
730724
Sets a advanced threat protection settings on a server.
731725

732726
### [Update-AzSqlServerVulnerabilityAssessmentSetting](Update-AzSqlServerVulnerabilityAssessmentSetting.md)
Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml
3+
Module Name: Az.Sql
4+
ms.assetid: FCCB768A-A034-44AF-B4B6-2AD3133B08EF
5+
online version: https://docs.microsoft.com/en-us/powershell/module/az.sql/Clear-AzSqlDatabaseAdvancedThreatProtectionSetting
6+
schema: 2.0.0
7+
---
8+
9+
# Clear-AzSqlDatabaseAdvancedThreatProtectionSetting
10+
11+
## SYNOPSIS
12+
Removes the advanced threat protection settings from a database.
13+
14+
## SYNTAX
15+
16+
```
17+
Clear-AzSqlDatabaseAdvancedThreatProtectionSetting [-PassThru] [-ServerName] <String> [-DatabaseName] <String>
18+
[-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
19+
[<CommonParameters>]
20+
```
21+
22+
## DESCRIPTION
23+
The **Clear-AzSqlDatabaseAdvancedThreatProtectionSetting** cmdlet removes the advanced threat protection settings from an AzureAzure SQL database.
24+
To use this cmdlet, specify the *ResourceGroupName* and *ServerName* parameters to identify the database from which this cmdlet removes the settings.
25+
26+
## EXAMPLES
27+
28+
### Example 1: Remove a advanced threat protection settings for a database
29+
```
30+
PS C:\>Clear-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01"
31+
```
32+
33+
This command removes the advanced threat protection settings from a database named Database01 on the server named Server01.
34+
35+
## PARAMETERS
36+
37+
### -DatabaseName
38+
Specifies the name of a database where the advanced threat protection settings should be removed.
39+
40+
```yaml
41+
Type: System.String
42+
Parameter Sets: (All)
43+
Aliases:
44+
45+
Required: True
46+
Position: 2
47+
Default value: None
48+
Accept pipeline input: True (ByPropertyName)
49+
Accept wildcard characters: False
50+
```
51+
52+
### -DefaultProfile
53+
The credentials, account, tenant, and subscription used for communication with azure
54+
55+
```yaml
56+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
57+
Parameter Sets: (All)
58+
Aliases: AzContext, AzureRmContext, AzureCredential
59+
60+
Required: False
61+
Position: Named
62+
Default value: None
63+
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
67+
### -PassThru
68+
Returns an object representing the item with which you are working.
69+
By default, this cmdlet does not generate any output.
70+
71+
```yaml
72+
Type: System.Management.Automation.SwitchParameter
73+
Parameter Sets: (All)
74+
Aliases:
75+
76+
Required: False
77+
Position: Named
78+
Default value: None
79+
Accept pipeline input: False
80+
Accept wildcard characters: False
81+
```
82+
83+
### -ResourceGroupName
84+
Specifies the name of the resource group the server belongs.
85+
86+
```yaml
87+
Type: System.String
88+
Parameter Sets: (All)
89+
Aliases:
90+
91+
Required: True
92+
Position: 0
93+
Default value: None
94+
Accept pipeline input: True (ByPropertyName)
95+
Accept wildcard characters: False
96+
```
97+
98+
### -ServerName
99+
Specifies the name of a server on which the database runs.
100+
101+
```yaml
102+
Type: System.String
103+
Parameter Sets: (All)
104+
Aliases:
105+
106+
Required: True
107+
Position: 1
108+
Default value: None
109+
Accept pipeline input: True (ByPropertyName)
110+
Accept wildcard characters: False
111+
```
112+
113+
### -Confirm
114+
Prompts you for confirmation before running the cmdlet.
115+
116+
```yaml
117+
Type: System.Management.Automation.SwitchParameter
118+
Parameter Sets: (All)
119+
Aliases: cf
120+
121+
Required: False
122+
Position: Named
123+
Default value: None
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
```
127+
128+
### -WhatIf
129+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
130+
131+
```yaml
132+
Type: System.Management.Automation.SwitchParameter
133+
Parameter Sets: (All)
134+
Aliases: wi
135+
136+
Required: False
137+
Position: Named
138+
Default value: None
139+
Accept pipeline input: False
140+
Accept wildcard characters: False
141+
```
142+
143+
### CommonParameters
144+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
145+
146+
## INPUTS
147+
148+
### System.String
149+
150+
## OUTPUTS
151+
152+
### Microsoft.Azure.Commands.Sql.ThreatDetection.Model.DatabaseThreatDetectionsettingsModel
153+
154+
## NOTES
155+
156+
## RELATED LINKS
157+
158+
[SQL Database Documentation](https://docs.microsoft.com/azure/sql-database/)
159+
160+

src/Sql/Sql/help/Clear-AzSqlServerAdvancedThreatProtectionSettings.md renamed to src/Sql/Sql/help/Clear-AzSqlServerAdvancedThreatProtectionSetting.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,32 @@
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml
33
Module Name: Az.Sql
44
ms.assetid: DCAB75A1-B4EF-4C41-9D6B-A954B6DB0028
5-
online version: https://docs.microsoft.com/en-us/powershell/module/az.sql/Clear-AzSqlServerAdvancedThreatProtectionSettings
5+
online version: https://docs.microsoft.com/en-us/powershell/module/az.sql/Clear-AzSqlServerAdvancedThreatProtectionSetting
66
schema: 2.0.0
77
---
88

9-
# Clear-AzSqlServerAdvancedThreatProtectionSettings
9+
# Clear-AzSqlServerAdvancedThreatProtectionSetting
1010

1111
## SYNOPSIS
1212
Removes the advanced threat protection settings from a server.
1313

1414
## SYNTAX
1515

1616
```
17-
Clear-AzSqlServerAdvancedThreatProtectionSettings [-PassThru] -ServerName <String>
17+
Clear-AzSqlServerAdvancedThreatProtectionSetting [-PassThru] -ServerName <String>
1818
[-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
1919
[<CommonParameters>]
2020
```
2121

2222
## DESCRIPTION
23-
The Clear-AzSqlServerAdvancedThreatProtectionSettings cmdlet removes the advanced threat protection settings from an Azure SQL server.
23+
The Clear-AzSqlServerAdvancedThreatProtectionSetting cmdlet removes the advanced threat protection settings from an Azure SQL server.
2424
To use this cmdlet, specify the ResourceGroupName and ServerName parameters to identify the server from which this cmdlet removes the settings.
2525

2626
## EXAMPLES
2727

2828
### Example 1: Remove a advanced threat protection settings for a database
2929
```
30-
PS C:\> Clear-AzSqlServerAdvancedThreatProtectionSettings -ResourceGroupName "ResourceGroup11" -ServerName "Server01"
30+
PS C:\> Clear-AzSqlServerAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01"
3131
```
3232

3333
This command removes the advanced threat protection settings from a server named Server01.

src/Sql/Sql/help/Get-AzSqlDatabaseAdvancedThreatProtectionSettings.md renamed to src/Sql/Sql/help/Get-AzSqlDatabaseAdvancedThreatProtectionSetting.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,32 @@
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml
33
Module Name: Az.Sql
44
ms.assetid: 017EF522-ABC5-40EE-B8DC-369D097F49D0
5-
online version: https://docs.microsoft.com/en-us/powershell/module/az.sql/get-azsqldatabaseAdvancedThreatProtectionSettings
5+
online version: https://docs.microsoft.com/en-us/powershell/module/az.sql/get-AzSqlDatabaseAdvancedThreatProtectionSetting
66
schema: 2.0.0
77
---
88

9-
# Get-AzSqlDatabaseAdvancedThreatProtectionSettings
9+
# Get-AzSqlDatabaseAdvancedThreatProtectionSetting
1010

1111
## SYNOPSIS
1212
Gets the advanced threat protection settings for a database.
1313

1414
## SYNTAX
1515

1616
```
17-
Get-AzSqlDatabaseAdvancedThreatProtectionSettings [-ServerName] <String> [-DatabaseName] <String>
17+
Get-AzSqlDatabaseAdvancedThreatProtectionSetting [-ServerName] <String> [-DatabaseName] <String>
1818
[-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
1919
[<CommonParameters>]
2020
```
2121

2222
## DESCRIPTION
23-
The **Get-AzSqlDatabaseAdvancedThreatProtectionSettings** cmdlet gets the advanced threat protection settings of an Azure SQL database.
23+
The **Get-AzSqlDatabaseAdvancedThreatProtectionSetting** cmdlet gets the advanced threat protection settings of an Azure SQL database.
2424
To use this cmdlet, specify the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database for which this cmdlet gets the settings.
2525

2626
## EXAMPLES
2727

2828
### Example 1: Get the advanced threat protection settings for a database
2929
```
30-
PS C:\>Get-AzSqlDatabaseAdvancedThreatProtectionSettings -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01"
30+
PS C:\>Get-AzSqlDatabaseAdvancedThreatProtectionSetting -ResourceGroupName "ResourceGroup11" -ServerName "Server01" -DatabaseName "Database01"
3131
DatabaseName : Database01
3232
ResourceGroupName : ResourceGroup11
3333
ServerName : Server01
@@ -150,7 +150,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
150150
151151
## RELATED LINKS
152152
153-
[Remove-AzSqlDatabaseAdvancedThreatProtectionSettings](./Remove-AzSqlDatabaseAdvancedThreatProtectionSettings.md)
153+
[Remove-AzSqlDatabaseAdvancedThreatProtectionSetting](./Remove-AzSqlDatabaseAdvancedThreatProtectionSetting.md)
154154
155155
156156

src/Sql/Sql/help/Get-AzSqlServerAdvancedThreatProtectionPolicy.md

Lines changed: 0 additions & 60 deletions
This file was deleted.

0 commit comments

Comments
 (0)