Skip to content

Commit 346f9a8

Browse files
brandong-msbrandong-ms
committed
Update help module
1 parent 81edd22 commit 346f9a8

File tree

323 files changed

+6446
-1208
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

323 files changed

+6446
-1208
lines changed

‎src/Sql/Sql/ChangeLog.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
- Updated `AzureSqlDatabaseBackupLongTermRetentionPolicyModel` to add `TimeBasedImmutability` and `TimeBasedImmutabilityMode` properties.
2424
- Updated `AzureSqlDatabaseLongTermRetentionBackupModel` to add `TimeBasedImmutability`, `TimeBasedImmutabilityMode`, and `LegalHoldImmutability` properties.
2525
- Added new cmdlets `Lock-AzSqlDatabaseLongTermRetentionBackupImmutability` and `Remove-AzSqlDatabaseLongTermRetentionBackupImmutability` for managing time-based immutability on LTR backups.
26-
- Added new cmdlets `Set-Az SqlDatabaseLongTermRetentionBackupLegalHold` and `Remove-AzSqlDatabaseLongTermRetentionBackupLegalHold` for managing legal hold immutability on LTR backups.
26+
- Added new cmdlets `Set-AzSqlDatabaseLongTermRetentionBackupLegalHold` and `Remove-AzSqlDatabaseLongTermRetentionBackupLegalHold` for managing legal hold immutability on LTR backups.
2727

2828
## Version 6.2.0
2929
* Improved parameter validation for the EnableSoftDelete and SoftDeleteRetentionDays parameters.

‎src/Sql/Sql/help/Add-AzSqlDatabaseToFailoverGroup.md‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Adds one or more databases to an Azure SQL Database Failover Group.
1616
Add-AzSqlDatabaseToFailoverGroup [-ServerName] <String> [-FailoverGroupName] <String>
1717
-Database <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel]>
1818
[-SecondaryType <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>]
19-
[<CommonParameters>]
19+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
2020
```
2121

2222
## DESCRIPTION
@@ -97,6 +97,21 @@ Accept pipeline input: True (ByPropertyName)
9797
Accept wildcard characters: False
9898
```
9999
100+
### -ProgressAction
101+
{{ Fill ProgressAction Description }}
102+
103+
```yaml
104+
Type: System.Management.Automation.ActionPreference
105+
Parameter Sets: (All)
106+
Aliases: proga
107+
108+
Required: False
109+
Position: Named
110+
Default value: None
111+
Accept pipeline input: False
112+
Accept wildcard characters: False
113+
```
114+
100115
### -ResourceGroupName
101116
The name of the resource group.
102117

‎src/Sql/Sql/help/Add-AzSqlElasticJobStep.md‎

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Add-AzSqlElasticJobStep [-ResourceGroupName] <String> [-ServerName] <String> [-A
1818
[-JobName] <String> -TargetGroupName <String> [-CredentialName <String>] -CommandText <String> -Name <String>
1919
[-StepId <Int32>] [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>]
2020
[-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>]
21-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
22+
[<CommonParameters>]
2223
```
2324

2425
### WithOutputDb
@@ -28,8 +29,8 @@ Add-AzSqlElasticJobStep [-ResourceGroupName] <String> [-ServerName] <String> [-A
2829
-OutputDatabaseObject <AzureSqlDatabaseModel> [-OutputCredentialName <String>] -OutputTableName <String>
2930
-Name <String> [-OutputSchemaName <String>] [-StepId <Int32>] [-TimeoutSeconds <Int32>]
3031
[-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] [-MaximumRetryIntervalSeconds <Int32>]
31-
[-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
32-
[<CommonParameters>]
32+
[-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>]
33+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
3334
```
3435

3536
### WithOutputDbId
@@ -39,17 +40,17 @@ Add-AzSqlElasticJobStep [-ResourceGroupName] <String> [-ServerName] <String> [-A
3940
-OutputDatabaseResourceId <String> [-OutputCredentialName <String>] -OutputTableName <String> -Name <String>
4041
[-OutputSchemaName <String>] [-StepId <Int32>] [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>]
4142
[-InitialRetryIntervalSeconds <Int32>] [-MaximumRetryIntervalSeconds <Int32>]
42-
[-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
43-
[<CommonParameters>]
43+
[-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>]
44+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
4445
```
4546

4647
### ObjectSet
4748
```
4849
Add-AzSqlElasticJobStep [-ParentObject] <AzureSqlElasticJobModel> -TargetGroupName <String>
4950
[-CredentialName <String>] -CommandText <String> -Name <String> [-StepId <Int32>] [-TimeoutSeconds <Int32>]
5051
[-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>] [-MaximumRetryIntervalSeconds <Int32>]
51-
[-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
52-
[<CommonParameters>]
52+
[-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>]
53+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
5354
```
5455

5556
### WithOutputDbUsingParentObject
@@ -59,7 +60,8 @@ Add-AzSqlElasticJobStep [-ParentObject] <AzureSqlElasticJobModel> -TargetGroupNa
5960
[-OutputCredentialName <String>] -OutputTableName <String> -Name <String> [-OutputSchemaName <String>]
6061
[-StepId <Int32>] [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>]
6162
[-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>]
62-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
63+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
64+
[<CommonParameters>]
6365
```
6466

6567
### WithOutputDbIdUsingParentObject
@@ -69,16 +71,17 @@ Add-AzSqlElasticJobStep [-ParentObject] <AzureSqlElasticJobModel> -TargetGroupNa
6971
[-OutputCredentialName <String>] -OutputTableName <String> -Name <String> [-OutputSchemaName <String>]
7072
[-StepId <Int32>] [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>]
7173
[-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>]
72-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
74+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
75+
[<CommonParameters>]
7376
```
7477

7578
### ResourceIdSet
7679
```
7780
Add-AzSqlElasticJobStep [-ParentResourceId] <String> -TargetGroupName <String> [-CredentialName <String>]
7881
-CommandText <String> -Name <String> [-StepId <Int32>] [-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>]
7982
[-InitialRetryIntervalSeconds <Int32>] [-MaximumRetryIntervalSeconds <Int32>]
80-
[-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
81-
[<CommonParameters>]
83+
[-RetryIntervalBackoffMultiplier <Double>] [-DefaultProfile <IAzureContextContainer>]
84+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
8285
```
8386

8487
### WithOutputDbUsingParentResourceId
@@ -88,7 +91,8 @@ Add-AzSqlElasticJobStep [-ParentResourceId] <String> -TargetGroupName <String> [
8891
-OutputTableName <String> -Name <String> [-OutputSchemaName <String>] [-StepId <Int32>]
8992
[-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>]
9093
[-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>]
91-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
94+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
95+
[<CommonParameters>]
9296
```
9397

9498
### WithOutputDbIdUsingParentResourceId
@@ -98,7 +102,8 @@ Add-AzSqlElasticJobStep [-ParentResourceId] <String> -TargetGroupName <String> [
98102
-OutputTableName <String> -Name <String> [-OutputSchemaName <String>] [-StepId <Int32>]
99103
[-TimeoutSeconds <Int32>] [-RetryAttempts <Int32>] [-InitialRetryIntervalSeconds <Int32>]
100104
[-MaximumRetryIntervalSeconds <Int32>] [-RetryIntervalBackoffMultiplier <Double>]
101-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
105+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
106+
[<CommonParameters>]
102107
```
103108

104109
## DESCRIPTION
@@ -347,6 +352,21 @@ Accept pipeline input: True (ByPropertyName)
347352
Accept wildcard characters: False
348353
```
349354
355+
### -ProgressAction
356+
{{ Fill ProgressAction Description }}
357+
358+
```yaml
359+
Type: System.Management.Automation.ActionPreference
360+
Parameter Sets: (All)
361+
Aliases: proga
362+
363+
Required: False
364+
Position: Named
365+
Default value: None
366+
Accept pipeline input: False
367+
Accept wildcard characters: False
368+
```
369+
350370
### -ResourceGroupName
351371
The resource group name
352372

‎src/Sql/Sql/help/Add-AzSqlElasticJobTarget.md‎

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,63 +16,67 @@ Adds a target to a target group
1616
```
1717
Add-AzSqlElasticJobTarget [-Exclude] [-ResourceGroupName] <String> [-AgentServerName] <String>
1818
[-AgentName] <String> [-TargetGroupName] <String> -ServerName <String> -DatabaseName <String>
19-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
19+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
20+
[<CommonParameters>]
2021
```
2122

2223
### SqlServerOrElasticPool
2324
```
2425
Add-AzSqlElasticJobTarget [-Exclude] [-ResourceGroupName] <String> [-AgentServerName] <String>
2526
[-AgentName] <String> [-TargetGroupName] <String> -ServerName <String> [-ElasticPoolName <String>]
26-
[-RefreshCredentialName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
27-
[<CommonParameters>]
27+
[-RefreshCredentialName <String>] [-DefaultProfile <IAzureContextContainer>]
28+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
2829
```
2930

3031
### SqlShardMap
3132
```
3233
Add-AzSqlElasticJobTarget [-Exclude] [-ResourceGroupName] <String> [-AgentServerName] <String>
3334
[-AgentName] <String> [-TargetGroupName] <String> -ServerName <String> -ShardMapName <String>
34-
-DatabaseName <String> [-RefreshCredentialName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
35-
[-Confirm] [<CommonParameters>]
35+
-DatabaseName <String> [-RefreshCredentialName <String>] [-DefaultProfile <IAzureContextContainer>]
36+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
3637
```
3738

3839
### SqlDatabaseUsingParentObject
3940
```
4041
Add-AzSqlElasticJobTarget [-Exclude] [-ParentObject] <AzureSqlElasticJobTargetGroupModel> -ServerName <String>
41-
-DatabaseName <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
42+
-DatabaseName <String> [-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>]
43+
[-WhatIf] [-Confirm] [<CommonParameters>]
4244
```
4345

4446
### SqlServerOrElasticPoolUsingParentObject
4547
```
4648
Add-AzSqlElasticJobTarget [-Exclude] [-ParentObject] <AzureSqlElasticJobTargetGroupModel> -ServerName <String>
4749
[-ElasticPoolName <String>] [-RefreshCredentialName <String>] [-DefaultProfile <IAzureContextContainer>]
48-
[-WhatIf] [-Confirm] [<CommonParameters>]
50+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
4951
```
5052

5153
### SqlShardMapUsingParentObject
5254
```
5355
Add-AzSqlElasticJobTarget [-Exclude] [-ParentObject] <AzureSqlElasticJobTargetGroupModel> -ServerName <String>
5456
-ShardMapName <String> -DatabaseName <String> [-RefreshCredentialName <String>]
55-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
57+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
58+
[<CommonParameters>]
5659
```
5760

5861
### SqlDatabaseUsingParentResourceId
5962
```
6063
Add-AzSqlElasticJobTarget [-Exclude] [-ParentResourceId] <String> -ServerName <String> -DatabaseName <String>
61-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
64+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
65+
[<CommonParameters>]
6266
```
6367

6468
### SqlServerOrElasticPoolUsingParentResourceId
6569
```
6670
Add-AzSqlElasticJobTarget [-Exclude] [-ParentResourceId] <String> -ServerName <String>
6771
[-ElasticPoolName <String>] [-RefreshCredentialName <String>] [-DefaultProfile <IAzureContextContainer>]
68-
[-WhatIf] [-Confirm] [<CommonParameters>]
72+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
6973
```
7074

7175
### SqlShardMapUsingParentResourceId
7276
```
7377
Add-AzSqlElasticJobTarget [-Exclude] [-ParentResourceId] <String> -ServerName <String> -ShardMapName <String>
74-
-DatabaseName <String> [-RefreshCredentialName <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
75-
[-Confirm] [<CommonParameters>]
78+
-DatabaseName <String> [-RefreshCredentialName <String>] [-DefaultProfile <IAzureContextContainer>]
79+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
7680
```
7781

7882
## DESCRIPTION
@@ -251,6 +255,21 @@ Accept pipeline input: True (ByPropertyName)
251255
Accept wildcard characters: False
252256
```
253257
258+
### -ProgressAction
259+
{{ Fill ProgressAction Description }}
260+
261+
```yaml
262+
Type: System.Management.Automation.ActionPreference
263+
Parameter Sets: (All)
264+
Aliases: proga
265+
266+
Required: False
267+
Position: Named
268+
Default value: None
269+
Accept pipeline input: False
270+
Accept wildcard characters: False
271+
```
272+
254273
### -RefreshCredentialName
255274
Refresh Credential Name
256275

‎src/Sql/Sql/help/Add-AzSqlInstanceKeyVaultKey.md‎

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,22 @@ Adds a key vault key to the provided Managed Instance.
1515
### AddAzureRmSqlManagedInstanceKeyVaultKeyDefaultParameterSet (Default)
1616
```
1717
Add-AzSqlInstanceKeyVaultKey [-ResourceGroupName] <String> [-InstanceName] <String> [-KeyId] <String>
18-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
19+
[<CommonParameters>]
1920
```
2021

2122
### AddAzureRmSqlManagedInstanceKeyVaultKeyInputObjectParameterSet
2223
```
2324
Add-AzSqlInstanceKeyVaultKey [-Instance] <AzureSqlManagedInstanceModel> [-KeyId] <String>
24-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
25+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
26+
[<CommonParameters>]
2527
```
2628

2729
### AddAzureRmSqlManagedInstanceKeyVaultKeyResourceIdParameterSet
2830
```
2931
Add-AzSqlInstanceKeyVaultKey [-InstanceResourceId] <String> [-KeyId] <String>
30-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
32+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
33+
[<CommonParameters>]
3134
```
3235

3336
## DESCRIPTION
@@ -185,6 +188,21 @@ Accept pipeline input: False
185188
Accept wildcard characters: False
186189
```
187190
191+
### -ProgressAction
192+
{{ Fill ProgressAction Description }}
193+
194+
```yaml
195+
Type: System.Management.Automation.ActionPreference
196+
Parameter Sets: (All)
197+
Aliases: proga
198+
199+
Required: False
200+
Position: Named
201+
Default value: None
202+
Accept pipeline input: False
203+
Accept wildcard characters: False
204+
```
205+
188206
### -ResourceGroupName
189207
The Resource Group Name
190208

‎src/Sql/Sql/help/Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate.md‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Adds a Transparent Data Encryption Certificate for the given managed instance
1515
```
1616
Add-AzSqlManagedInstanceTransparentDataEncryptionCertificate [-PassThru] [-ResourceGroupName] <String>
1717
[-ManagedInstanceName] <String> [-PrivateBlob] <SecureString> [-Password] <SecureString>
18-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
19+
[<CommonParameters>]
1920
```
2021

2122
## DESCRIPTION
@@ -107,6 +108,21 @@ Accept pipeline input: False
107108
Accept wildcard characters: False
108109
```
109110
111+
### -ProgressAction
112+
{{ Fill ProgressAction Description }}
113+
114+
```yaml
115+
Type: System.Management.Automation.ActionPreference
116+
Parameter Sets: (All)
117+
Aliases: proga
118+
119+
Required: False
120+
Position: Named
121+
Default value: None
122+
Accept pipeline input: False
123+
Accept wildcard characters: False
124+
```
125+
110126
### -ResourceGroupName
111127
The Resource Group Name
112128

‎src/Sql/Sql/help/Add-AzSqlServerKeyVaultKey.md‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Adds a Key Vault key to a SQL server.
1414

1515
```
1616
Add-AzSqlServerKeyVaultKey [-KeyId] <String> [-AsJob] [-ServerName] <String> [-ResourceGroupName] <String>
17-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
17+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
18+
[<CommonParameters>]
1819
```
1920

2021
## DESCRIPTION
@@ -87,6 +88,21 @@ Accept pipeline input: True (ByPropertyName)
8788
Accept wildcard characters: False
8889
```
8990
91+
### -ProgressAction
92+
{{ Fill ProgressAction Description }}
93+
94+
```yaml
95+
Type: System.Management.Automation.ActionPreference
96+
Parameter Sets: (All)
97+
Aliases: proga
98+
99+
Required: False
100+
Position: Named
101+
Default value: None
102+
Accept pipeline input: False
103+
Accept wildcard characters: False
104+
```
105+
90106
### -ResourceGroupName
91107
The name of the resource group
92108

0 commit comments

Comments
 (0)