Skip to content

Commit e992cf0

Browse files
xaliciayangxaliciayang
committed
help files; changelog
1 parent 52ce17a commit e992cf0

12 files changed

+977
-50
lines changed

‎src/Sql/Sql/ChangeLog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@
2020
## Upcoming Release
2121
* Added support for cross subscription point in time restore on Managed Instances.
2222
* Add support for changing existing Sql Managed Instance hardware generation
23+
* Added support for Long Term Retention services for Managed instances
24+
- Get/Set LTR policy on a managed database
25+
- Get LTR backup(s) by managed database, managed instance, or by location
26+
- Remove an LTR backup
27+
- Restore an LTR backup to create a new managed database
2328

2429
## Version 2.2.0
2530
Fix New-AzSqlDatabaseSecondary cmdlet to check for PartnerDatabaseName existence instead of DatabaseName existence.

‎src/Sql/Sql/Properties/Resources.resx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -590,9 +590,9 @@
590590
<value>You cannot change hardware family.</value>
591591
</data>
592592
<data name="RemoveAzureSqlInstanceDatabaseLongTermRetentionBackupDescription" xml:space="preserve">
593-
<value>Permanantly removing the Long Term Retention backup '{0}' on database '{1}' on server '{2}' in location '{3}'?</value>
593+
<value>Permanantly removing the Long Term Retention backup '{0}' on database '{1}' on instance '{2}' in location '{3}'?</value>
594594
</data>
595595
<data name="RemoveAzureSqlInstanceDatabaseLongTermRetentionBackupWarning" xml:space="preserve">
596-
<value>Are you sure you want to remove the Long Term Retention backup '{0}' on database '{1}' on server '{2}' in location '{3}'?</value>
596+
<value>Are you sure you want to remove the Long Term Retention backup '{0}' on database '{1}' on instance '{2}' in location '{3}'?</value>
597597
</data>
598598
</root>

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

Lines changed: 15 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -62,29 +62,29 @@ Converts a vulnerability assessment scan results to Excel format.
6262
### [Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan](Convert-AzSqlInstanceDatabaseVulnerabilityAssessmentScan.md)
6363
Converts a vulnerability assessment scan results to Excel format.
6464

65-
### [Disable-AzSqlDatabaseSensitivityRecommendation](Disable-AzSqlDatabaseSensitivityRecommendation)
66-
Disables sensitivity recommendations on columns in the database.
65+
### [Disable-AzSqlDatabaseSensitivityRecommendation](Disable-AzSqlDatabaseSensitivityRecommendation.md)
66+
Disables (dismisses) sensitivity recommendations on columns in the database.
6767

6868
### [Disable-AzSqlInstanceAdvancedDataSecurity](Disable-AzSqlInstanceAdvancedDataSecurity.md)
6969
Disables Advanced Data Security on a managed instance.
7070

71-
### [Disable-AzSqlInstanceDatabaseSensitivityRecommendation](Disable-AzSqlInstanceDatabaseSensitivityRecommendation)
72-
Disbles sensitivity recommendations on columns in the Azure SQL managed instance database.
71+
### [Disable-AzSqlInstanceDatabaseSensitivityRecommendation](Disable-AzSqlInstanceDatabaseSensitivityRecommendation.md)
72+
Disables (dismisses) sensitivity recommendations on columns in the Azure SQL managed instance database.
7373

7474
### [Disable-AzSqlServerAdvancedDataSecurity](Disable-AzSqlServerAdvancedDataSecurity.md)
7575
Disables Advanced Data Security on a server.
7676

7777
### [Disable-AzSqlServerAdvancedThreatProtection](Disable-AzSqlServerAdvancedThreatProtection.md)
7878
Disables Advanced Threat Protection on a server.
7979

80-
### [Enable-AzSqlDatabaseSensitivityRecommendation](Enable-AzSqlDatabaseSensitivityRecommendation)
81-
Enables sensitivity recommendations on columns in the database.
80+
### [Enable-AzSqlDatabaseSensitivityRecommendation](Enable-AzSqlDatabaseSensitivityRecommendation.md)
81+
Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the database.
8282

8383
### [Enable-AzSqlInstanceAdvancedDataSecurity](Enable-AzSqlInstanceAdvancedDataSecurity.md)
8484
Enables Advanced Data Security on a managed instance.
8585

86-
### [Enable-AzSqlInstanceDatabaseSensitivityRecommendation](Enable-AzSqlInstanceDatabaseSensitivityRecommendation)
87-
Enables sensitivity recommendations on columns in the Azure SQL managed instance database.
86+
### [Enable-AzSqlInstanceDatabaseSensitivityRecommendation](Enable-AzSqlInstanceDatabaseSensitivityRecommendation.md)
87+
Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the Azure SQL managed instance database.
8888

8989
### [Enable-AzSqlServerAdvancedDataSecurity](Enable-AzSqlServerAdvancedDataSecurity.md)
9090
Enables Advanced Data Security on a server.
@@ -110,11 +110,6 @@ Gets one or more Advisors for an Azure SQL Database.
110110
### [Get-AzSqlDatabaseAudit](Get-AzSqlDatabaseAudit.md)
111111
Gets the auditing settings of an Azure SQL database.
112112

113-
### [Get-AzSqlDatabaseAuditing](Get-AzSqlDatabaseAuditing.md)
114-
**Important: This cmdlet is deprecated, [Get-AzSqlDatbaseAudit](https://docs.microsoft.com/en-us/powershell/module/az.sql/get-azsqldatabaseaudit) is replacing it.**
115-
116-
Gets the auditing settings of an Azure SQL database.
117-
118113
### [Get-AzSqlDatabaseBackupLongTermRetentionPolicy](Get-AzSqlDatabaseBackupLongTermRetentionPolicy.md)
119114
Gets a database long term retention policy.
120115

@@ -286,20 +281,18 @@ Returns information about SQL Database servers.
286281
### [Get-AzSqlServerActiveDirectoryAdministrator](Get-AzSqlServerActiveDirectoryAdministrator.md)
287282
Gets information about an Azure AD administrator for SQL Server.
288283

284+
### [Get-AzSqlServerAdvancedDataSecurityPolicy](Get-AzSqlServerAdvancedDataSecurityPolicy.md)
285+
Gets Advanced Data Security policy of a server.
286+
289287
### [Get-AzSqlServerAdvancedThreatProtectionSetting](Get-AzSqlServerAdvancedThreatProtectionSetting.md)
290-
Gets Advanced Threat Protection policy of a server.
288+
Gets the advanced threat protection settings for a server.
291289

292290
### [Get-AzSqlServerAdvisor](Get-AzSqlServerAdvisor.md)
293291
Gets one or more Advisors for an Azure SQL Server.
294292

295293
### [Get-AzSqlServerAudit](Get-AzSqlServerAudit.md)
296294
Gets the auditing settings of an Azure SQL server.
297295

298-
### [Get-AzSqlServerAuditing](Get-AzSqlServerAuditing.md)
299-
**Important: This cmdlet is deprecated, [Get-AzSqlServerAudit](https://docs.microsoft.com/en-us/powershell/module/az.sql/get-azsqlserveraudit) is replacing it.**
300-
301-
Gets the auditing settings of an Azure SQL server.
302-
303296
### [Get-AzSqlServerCommunicationLink](Get-AzSqlServerCommunicationLink.md)
304297
Gets communication links for elastic database transactions between database servers.
305298

@@ -570,11 +563,6 @@ Modifies auto execute status of an Azure SQL Database Advisor.
570563
### [Set-AzSqlDatabaseAudit](Set-AzSqlDatabaseAudit.md)
571564
Changes the auditing settings for an Azure SQL database.
572565

573-
### [Set-AzSqlDatabaseAuditing](Set-AzSqlDatabaseAuditing.md)
574-
**Important: This cmdlet is deprecated, [Set-AzSqlDatabaseAudit](https://docs.microsoft.com/en-us/powershell/module/az.sql/set-azsqldatabaseaudit) is replacing it.**
575-
576-
Changes the auditing settings for an Azure SQL database.
577-
578566
### [Set-AzSqlDatabaseBackupLongTermRetentionPolicy](Set-AzSqlDatabaseBackupLongTermRetentionPolicy.md)
579567
Sets a server long term retention policy.
580568

@@ -665,11 +653,6 @@ Updates the auto execute status of an Azure SQL Server Advisor.
665653
### [Set-AzSqlServerAudit](Set-AzSqlServerAudit.md)
666654
Changes the auditing settings of an Azure SQL server.
667655

668-
### [Set-AzSqlServerAuditing](Set-AzSqlServerAuditing.md)
669-
**Important: This cmdlet is deprecated, [Set-AzSqlServerAudit](https://docs.microsoft.com/en-us/powershell/module/az.sql/set-azsqlserveraudit) is replacing it.**
670-
671-
Changes the auditing settings of an Azure SQL server.
672-
673656
### [Set-AzSqlServerDisasterRecoveryConfiguration](Set-AzSqlServerDisasterRecoveryConfiguration.md)
674657
Modifies a database server recovery configuration.
675658

@@ -727,6 +710,9 @@ Executes a failover of an Azure SQL Database Failover Group.
727710
### [Switch-AzSqlDatabaseInstanceFailoverGroup](Switch-AzSqlDatabaseInstanceFailoverGroup.md)
728711
Executes a failover of an Instance Failover Group.
729712

713+
### [Update-AzSqlDatabaseAdvancedThreatProtectionSetting](Update-AzSqlDatabaseAdvancedThreatProtectionSetting.md)
714+
Sets a advanced threat protection settings on a database.
715+
730716
### [Update-AzSqlDatabaseVulnerabilityAssessmentSetting](Update-AzSqlDatabaseVulnerabilityAssessmentSetting.md)
731717
Updates the vulnerability assessment settings of a database.
732718

‎src/Sql/Sql/help/Clear-AzSqlServerAdvancedThreatProtectionSetting.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,8 @@ Removes the advanced threat protection settings from a server.
1414
## SYNTAX
1515

1616
```
17-
Clear-AzSqlServerAdvancedThreatProtectionSetting [-PassThru] -ServerName <String>
18-
[-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
19-
[<CommonParameters>]
17+
Clear-AzSqlServerAdvancedThreatProtectionSetting [-PassThru] -ServerName <String> [-ResourceGroupName] <String>
18+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
2019
```
2120

2221
## DESCRIPTION

‎src/Sql/Sql/help/Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy.md

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml
3+
Module Name: Az.Sql
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy
9+
10+
## SYNOPSIS
11+
{{ Fill in the Synopsis }}
12+
13+
## SYNTAX
14+
15+
```
16+
Get-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy [-InstanceName] <String> [-DatabaseName] <String>
17+
[-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
18+
[<CommonParameters>]
19+
```
20+
21+
## DESCRIPTION
22+
{{ Fill in the Description }}
23+
24+
## EXAMPLES
25+
26+
### Example 1
27+
```powershell
28+
PS C:\> {{ Add example code here }}
29+
```
30+
31+
{{ Add example description here }}
32+
33+
## PARAMETERS
34+
35+
### -DatabaseName
36+
The name of the Azure Managed Database to use.
37+
38+
```yaml
39+
Type: String
40+
Parameter Sets: (All)
41+
Aliases:
42+
43+
Required: True
44+
Position: 2
45+
Default value: None
46+
Accept pipeline input: True (ByPropertyName)
47+
Accept wildcard characters: False
48+
```
49+
50+
### -DefaultProfile
51+
The credentials, account, tenant, and subscription used for communication with Azure.
52+
53+
```yaml
54+
Type: IAzureContextContainer
55+
Parameter Sets: (All)
56+
Aliases: AzContext, AzureRmContext, AzureCredential
57+
58+
Required: False
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -InstanceName
66+
The name of the Azure Managed Instance the database belongs to.
67+
68+
```yaml
69+
Type: String
70+
Parameter Sets: (All)
71+
Aliases:
72+
73+
Required: True
74+
Position: 1
75+
Default value: None
76+
Accept pipeline input: True (ByPropertyName)
77+
Accept wildcard characters: False
78+
```
79+
80+
### -ResourceGroupName
81+
The name of the resource group.
82+
83+
```yaml
84+
Type: String
85+
Parameter Sets: (All)
86+
Aliases:
87+
88+
Required: True
89+
Position: 0
90+
Default value: None
91+
Accept pipeline input: True (ByPropertyName)
92+
Accept wildcard characters: False
93+
```
94+
95+
### -Confirm
96+
Prompts you for confirmation before running the cmdlet.
97+
98+
```yaml
99+
Type: SwitchParameter
100+
Parameter Sets: (All)
101+
Aliases: cf
102+
103+
Required: False
104+
Position: Named
105+
Default value: None
106+
Accept pipeline input: False
107+
Accept wildcard characters: False
108+
```
109+
110+
### -WhatIf
111+
Shows what would happen if the cmdlet runs.
112+
The cmdlet is not run.
113+
114+
```yaml
115+
Type: SwitchParameter
116+
Parameter Sets: (All)
117+
Aliases: wi
118+
119+
Required: False
120+
Position: Named
121+
Default value: None
122+
Accept pipeline input: False
123+
Accept wildcard characters: False
124+
```
125+
126+
### CommonParameters
127+
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).
128+
129+
## INPUTS
130+
131+
### System.String
132+
133+
## OUTPUTS
134+
135+
### Microsoft.Azure.Commands.Sql.ManagedDatabaseBackup.Model.AzureSqlManagedDatabaseBackupLongTermRetentionPolicyModel
136+
137+
## NOTES
138+
139+
## RELATED LINKS

0 commit comments

Comments
 (0)