Skip to content

Commit c9a6656

Browse files
committed
Remove prompts from examples, and remove newlines from help files
1 parent 513ba9d commit c9a6656

5 files changed

+1
-33
lines changed

src/Sql/Sql/help/Lock-AzSqlDatabaseLongTermRetentionBackupImmutability.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,6 @@ Lock-AzSqlDatabaseLongTermRetentionBackupImmutability -Location northeurope -Ser
4747
```
4848

4949
```output
50-
Locking the time-based immutability for the Long Term Retention backup 'ddce125a-339f-4f34-9b74-93b439813ddd;133982942130000000;Hot' on database 'testdb2' on server 'brandong-ltr-ps-test' in location 'eastus2euap'.
51-
Are you sure you want to lock the time-based immutability for the Long Term Retention backup 'ddce125a-339f-4f34-9b74-93b439813ddd;133982942130000000;Hot' on database 'testdb2' on server 'brandong-ltr-ps-test' in location 'eastus2euap'? Once locked, the backup cannot be dropped until expiration.
52-
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
53-
5450
BackupExpirationTime : 8/5/2025 8:23:33 PM
5551
BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
5652
BackupTime : 7/29/2025 8:23:33 PM

src/Sql/Sql/help/Remove-AzSqlDatabaseLongTermRetentionBackupImmutability.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,24 +36,17 @@ Remove-AzSqlDatabaseLongTermRetentionBackupImmutability [-ResourceId] <String> [
3636
```
3737

3838
## DESCRIPTION
39-
4039
The cmdlet **Remove-AzSqlDatabaseLongTermRetentionBackupImmutability** permanently removes an unlocked time-based immutability policy for the backup.
4140
Once removed, the backup will be able to be deleted manually. It is not possible to re-add time-based immutability once it is removed (however, a legal hold can always be applied).
4241

4342
## EXAMPLES
4443

4544
### Example 1: Remove the time-based immutability policy for a single backup.
46-
4745
```powershell
4846
Remove-AzSqlDatabaseLongTermRetentionBackupImmutability -Location northeurope -ServerName server01 -DatabaseName testdb2 -BackupName "601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000" -PassThru
4947
```
5048

5149
```output
52-
Removing the time-based immutability for the Long Term Retention backup '601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000' on database 'testdb2' on server 'server01' in location 'northeurope'.
53-
Are you sure you want to remove the time-based immutability for the Long Term Retention backup '601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000' on database 'testdb2' on server 'server01' in location 'northeurope'? Once removed, it will be
54-
possible to delete the backup.
55-
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
56-
5750
BackupExpirationTime : 8/5/2025 8:23:33 PM
5851
BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
5952
BackupTime : 7/29/2025 8:23:33 PM

src/Sql/Sql/help/Remove-AzSqlDatabaseLongTermRetentionBackupLegalHold.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,26 +36,16 @@ Remove-AzSqlDatabaseLongTermRetentionBackupLegalHold [-ResourceId] <String> [-Fo
3636
```
3737

3838
## DESCRIPTION
39-
4039
The **Remove-AzSqlDatabaseLongTermRetentionBackupLegalHold** removes a legal hold on the given LTR backup. Once removed, the backup can be manually deleted. If the backup is expired, it will be dropped immediately after removal.
4140

4241
## EXAMPLES
4342

4443
### Example 1: Remove legal hold for a single backup
45-
4644
```powershell
4745
Remove-AzSqlDatabaseLongTermRetentionBackupLegalHold -Location northeurope -ServerName server01 -DatabaseName testdb -BackupName "601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000" -PassThru:$true
4846
```
4947

5048
```output
51-
Removing the legal hold immutability for the Long Term Retention backup
52-
'601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000' on database 'testdb' on server 'server01' in
53-
location 'northeurope'.
54-
Are you sure you want to remove a legal hold for the Long Term Retention backup
55-
'601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000' on database 'testdb' on server 'server01' in
56-
location 'northeurope'? Once removed, it will be possible to delete the backup.
57-
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
58-
5949
BackupExpirationTime : 8/5/2025 8:08:27 PM
6050
BackupName : 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
6151
BackupTime : 7/29/2025 8:08:27 PM

src/Sql/Sql/help/Set-AzSqlDatabaseBackupLongTermRetentionPolicy.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,12 @@ Set-AzSqlDatabaseBackupLongTermRetentionPolicy [-WeeklyRetention <String>] [-Mon
4747

4848

4949
## DESCRIPTION
50-
5150
The **Set-AzSqlDatabaseBackupLongTermRetentionPolicy** cmdlet sets the long term retention policy registered to this database.
5251
The policy is an Azure Backup resource used to define backup storage policy.
5352

5453
## EXAMPLES
5554

5655
### Example 1: Set the weekly retention for the current version of long term retention policy
57-
5856
```powershell
5957
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention P2W
6058
```
@@ -75,7 +73,6 @@ TimeBasedImmutabilityMode : Unlocked
7573
This sets the long term retention policy of database01 to save every weekly full backup for 2 weeks
7674

7775
### Example 2: Set the monthly retention for the current version of long term retention policy
78-
7976
```powershell
8077
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -MonthlyRetention P5Y
8178
```
@@ -96,7 +93,6 @@ TimeBasedImmutabilityMode : Unlocked
9693
This sets the long term retention policy of database01 to save the first full backup of each month for 5 years
9794

9895
### Example 3: Set the yearly retention for the current version of long term retention policy
99-
10096
```powershell
10197
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -YearlyRetention P10Y -WeekOfYear 26
10298
```
@@ -117,7 +113,6 @@ TimeBasedImmutabilityMode : Unlocked
117113
This sets the long term retention policy of database01 to save the full backup taken on the 26th week of the year for 10 years
118114

119115
### Example 4: Set the yearly retention for the current version of long term retention policy with an unlocked time-based immutability enabled
120-
121116
```powershell
122117
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -YearlyRetention P10Y -WeekOfYear 26 -TimeBasedImmutability Enabled
123118
```
@@ -140,7 +135,6 @@ Additionally, the backups will be created with an unlocked time-based immutabili
140135
These backups can later have their immutability locked or removed.
141136

142137
### Example 5: Set the yearly retention for the current version of long term retention policy with a locked time-based immutability enabled
143-
144138
```powershell
145139
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -YearlyRetention P10Y -WeekOfYear 26 -TimeBasedImmutability Enabled -TimeBasedImmutabilityMode Locked
146140
```
@@ -163,7 +157,6 @@ Additionally, the backups will be created with a locked time-based immutability
163157
These backups can not be deleted manually and will only be dropped on expiration.
164158

165159
### Example 6: Set each retention for the current version of long term retention policy
166-
167160
```powershell
168161
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention 14 -MonthlyRetention P24W -YearlyRetention P10Y -WeekOfYear 26
169162
```
@@ -184,7 +177,6 @@ TimeBasedImmutabilityMode : Unlocked
184177
This sets the long term retention policy of database01 to save each full backup for 14 days, the first full backup of each month for 24 weeks, and the full backup taken on the 26th week of the year for 10 years
185178

186179
### Example 7: Remove the long term retention policy
187-
188180
```powershell
189181
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -RemovePolicy
190182
```
@@ -206,7 +198,6 @@ Removes the policy for database01 so it no longer saves any long term retention
206198
This will not affect backups that have already been taken.
207199

208200
### Example 8: Remove the long term retention policy
209-
210201
```powershell
211202
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention P0D
212203
```
@@ -226,6 +217,7 @@ TimeBasedImmutabilityMode : Unlocked
226217

227218
This is another way of removing the policy for database01 so it no longer saves any long term retention backups.
228219
This will not affect backups that have already been taken
220+
229221
## PARAMETERS
230222

231223
### -DatabaseName

src/Sql/Sql/help/Set-AzSqlDatabaseLongTermRetentionBackupLegalHold.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,11 @@ Set-AzSqlDatabaseLongTermRetentionBackupLegalHold [-ResourceId] <String> [-Force
3535
```
3636

3737
## DESCRIPTION
38-
3938
The **Set-AzSqlDatabaseLongTermRetentionBackupLegalHold** sets a legal hold on the given LTR backup. The backup cannot be deleted and will not expire until the legal hold is removed.
4039

4140
## EXAMPLES
4241

4342
### Example 1: Set legal hold on a single backup
44-
4543
```powershell
4644
PS C:\> Set-AzSqlDatabaseLongTermRetentionBackupLegalHold -Location northeurope -ServerName server01 -DatabaseName testdb -BackupName "601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000" -PassThru
4745
```
@@ -65,7 +63,6 @@ LegalHoldImmutability : Enabled
6563

6664
This sets legal hold on the backup 601061b7-d10b-46e0-bf77-a2bfb16a6add;131655666550000000
6765

68-
6966
## PARAMETERS
7067

7168
### -AsJob

0 commit comments

Comments
 (0)