Skip to content

Commit 3c204b6

Browse files
bashaheebashahee
committed
Update Help files
1 parent ad125d9 commit 3c204b6

File tree

3 files changed

+141
-118
lines changed

3 files changed

+141
-118
lines changed

‎src/Sql/Sql/DataClassification/Cmdlet/GetAzSqlInstanceDatabaseSensitivityRecommendations.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace Microsoft.Azure.Commands.Sql.DataClassification.Cmdlet
1010
{
1111
[Cmdlet(
1212
VerbsCommon.Get,
13-
ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ManagedDatabaseSensitivityRecommendations"),
13+
ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "SqlInstanceDatabaseSensitivityRecommendations"),
1414
OutputType(typeof(ManagedDatabaseSensitivityClassificationModel))]
1515
public class GetAzSqlInstanceDatabaseSensitivityRecommendations : AzureSqlCmdletBase<ManagedDatabaseSensitivityClassificationModel, DataClassificationAdapter>
1616
{

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

Lines changed: 77 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -2,57 +2,109 @@
22
external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml
33
Module Name: Az.Sql
44
ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1
5-
online version: https://docs.microsoft.com/en-us/powershell/module/az.sql/set-azsqldatabasesensitivityrecommendations
5+
online version: https://docs.microsoft.com/en-us/powershell/module/az.sql/get-azsqldatabasesensitivityrecommendations
66
schema: 2.0.0
77
---
88

9-
# Set-AzSqlDatabaseSensitivityRecommendations
9+
# Get-AzSqlDatabaseSensitivityRecommendations
1010

1111
## SYNOPSIS
12+
Gets the recommended sensitivity labels and information types of columns in the database.
1213

1314
## SYNTAX
1415

15-
### ColumnParameterSet
16+
### DatabaseParameterSet
1617
```
17-
Set-AzSqlDatabaseSensitivityClassification [-ResourceGroupName] <String> [-ServerName] <String>
18-
[-DatabaseName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-LabelName <String>]
19-
[-InformationType <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
20-
[<CommonParameters>]
18+
Get-AzSqlDatabaseSensitivityRecommendations [-ResourceGroupName] <String> [-ServerName] <String>
19+
[-DatabaseName] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2120
```
2221

2322
### ParentResourceParameterSet
2423
```
25-
Set-AzSqlDatabaseSensitivityClassification -InputObject <SqlDatabaseSensitivityClassificationModel>
26-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
24+
Get-AzSqlDatabaseSensitivityRecommendations -InputObject <AzureSqlDatabaseModel> [-AsJob]
25+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2726
```
2827

2928
## DESCRIPTION
29+
The Get-AzSqlDatabaseSensitivityRecommendations cmdlet returns the recommended sensitivity labels and information types of columns in the database.
3030

3131
## EXAMPLES
3232

33+
### Example 1: Get recommended sensitivity classification of an Azure SQL database.
34+
```powershell
35+
PS C:\> Get-AzSqlDatabaseSensitivityRecommendations -ResourceGroupName resourceGroup -ServerName server -DatabaseName database
36+
37+
ResourceGroupName : resourceGroup
38+
ServerName : server
39+
DatabaseName : database
40+
SensitivityLabels : {{
41+
SchemaName: schema1,
42+
TableName: table1,
43+
ColumnName: column1,
44+
LabelName: label1,
45+
InformationType: informationType1,
46+
}, {
47+
SchemaName: schema2,
48+
TableName: table2,
49+
ColumnName: column2,
50+
LabelName: label2,
51+
}, {
52+
SchemaName: schema3,
53+
TableName: table3,
54+
ColumnName: column3,
55+
LabelName: label3,
56+
}}
57+
```
58+
59+
### Example 2: Get recommended sensitivity classification of an Azure SQL database.
60+
```powershell
61+
PS C:\> Get-AzSqlDatabase -ResourceGroupName resourceGroup -ServerName server -DatabaseName database | Get-AzSqlDatabaseSensitivityRecommendations
62+
63+
ResourceGroupName : resourceGroup
64+
ServerName : server
65+
DatabaseName : database
66+
SensitivityLabels : {{
67+
SchemaName: schema1,
68+
TableName: table1,
69+
ColumnName: column1,
70+
LabelName: label1,
71+
InformationType: informationType1,
72+
}, {
73+
SchemaName: schema2,
74+
TableName: table2,
75+
ColumnName: column2,
76+
LabelName: label2,
77+
}, {
78+
SchemaName: schema3,
79+
TableName: table3,
80+
ColumnName: column3,
81+
LabelName: label3,
82+
}}
83+
```
84+
3385
## PARAMETERS
3486

35-
### -ColumnName
36-
Name of column.
87+
### -AsJob
88+
Run cmdlet in the background
3789

3890
```yaml
39-
Type: System.String
40-
Parameter Sets: ColumnParameterSet
91+
Type: System.Management.Automation.SwitchParameter
92+
Parameter Sets: (All)
4193
Aliases:
4294

43-
Required: True
95+
Required: False
4496
Position: Named
4597
Default value: None
46-
Accept pipeline input: True (ByPropertyName)
98+
Accept pipeline input: False
4799
Accept wildcard characters: False
48100
```
49101
50102
### -DatabaseName
51-
SQL Database name.
103+
The name of the Azure SQL Database.
52104
53105
```yaml
54106
Type: System.String
55-
Parameter Sets: ColumnParameterSet
107+
Parameter Sets: DatabaseParameterSet
56108
Aliases:
57109

58110
Required: True
@@ -77,26 +129,11 @@ Accept pipeline input: False
77129
Accept wildcard characters: False
78130
```
79131
80-
### -InformationType
81-
A name that describes the information type of the data stored in the column.
82-
83-
```yaml
84-
Type: System.String
85-
Parameter Sets: ColumnParameterSet
86-
Aliases:
87-
88-
Required: False
89-
Position: Named
90-
Default value: None
91-
Accept pipeline input: True (ByPropertyName)
92-
Accept wildcard characters: False
93-
```
94-
95132
### -InputObject
96-
An object representing a SQL Database Sensitivity Classification
133+
The SQL database object.
97134
98135
```yaml
99-
Type: Microsoft.Azure.Commands.Sql.DataClassification.Model.SqlDatabaseSensitivityClassificationModel
136+
Type: Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel
100137
Parameter Sets: ParentResourceParameterSet
101138
Aliases:
102139

@@ -107,27 +144,12 @@ Accept pipeline input: True (ByValue)
107144
Accept wildcard characters: False
108145
```
109146
110-
### -LabelName
111-
A name that describes the sensitivity of the data stored in the column.
112-
113-
```yaml
114-
Type: System.String
115-
Parameter Sets: ColumnParameterSet
116-
Aliases:
117-
118-
Required: False
119-
Position: Named
120-
Default value: None
121-
Accept pipeline input: True (ByPropertyName)
122-
Accept wildcard characters: False
123-
```
124-
125147
### -ResourceGroupName
126148
The name of the resource group.
127149
128150
```yaml
129151
Type: System.String
130-
Parameter Sets: ColumnParameterSet
152+
Parameter Sets: DatabaseParameterSet
131153
Aliases:
132154

133155
Required: True
@@ -137,27 +159,12 @@ Accept pipeline input: True (ByPropertyName)
137159
Accept wildcard characters: False
138160
```
139161
140-
### -SchemaName
141-
Name of schema.
142-
143-
```yaml
144-
Type: System.String
145-
Parameter Sets: ColumnParameterSet
146-
Aliases:
147-
148-
Required: True
149-
Position: Named
150-
Default value: None
151-
Accept pipeline input: True (ByPropertyName)
152-
Accept wildcard characters: False
153-
```
154-
155162
### -ServerName
156163
SQL server name.
157164
158165
```yaml
159166
Type: System.String
160-
Parameter Sets: ColumnParameterSet
167+
Parameter Sets: DatabaseParameterSet
161168
Aliases:
162169

163170
Required: True
@@ -167,58 +174,17 @@ Accept pipeline input: True (ByPropertyName)
167174
Accept wildcard characters: False
168175
```
169176
170-
### -TableName
171-
Name of table.
172-
173-
```yaml
174-
Type: System.String
175-
Parameter Sets: ColumnParameterSet
176-
Aliases:
177-
178-
Required: True
179-
Position: Named
180-
Default value: None
181-
Accept pipeline input: True (ByPropertyName)
182-
Accept wildcard characters: False
183-
```
184-
185-
### -Confirm
186-
Prompts you for confirmation before running the cmdlet.
187-
188-
```yaml
189-
Type: System.Management.Automation.SwitchParameter
190-
Parameter Sets: (All)
191-
Aliases: cf
192-
193-
Required: False
194-
Position: Named
195-
Default value: None
196-
Accept pipeline input: False
197-
Accept wildcard characters: False
198-
```
199-
200-
### -WhatIf
201-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
202-
203-
```yaml
204-
Type: System.Management.Automation.SwitchParameter
205-
Parameter Sets: (All)
206-
Aliases: wi
207-
208-
Required: False
209-
Position: Named
210-
Default value: None
211-
Accept pipeline input: False
212-
Accept wildcard characters: False
213-
```
214-
215177
### CommonParameters
216178
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).
217179
218180
## INPUTS
219181
182+
### Microsoft.Azure.Commands.Sql.Database.Model.AzureSqlDatabaseModel
183+
220184
## OUTPUTS
221185
186+
### Microsoft.Azure.Commands.Sql.DataClassification.Model.SqlDatabaseSensitivityClassificationModel
187+
222188
## NOTES
223189
224190
## RELATED LINKS

0 commit comments

Comments
 (0)