Skip to content

Commit 3e880b1

Browse files
bashaheebashahee
committed
Update help files
1 parent 58c0dd0 commit 3e880b1

7 files changed

+111
-24
lines changed

‎src/Sql/Sql/Az.Sql.psd1

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -199,14 +199,14 @@ CmdletsToExport = 'Get-AzSqlDatabaseTransparentDataEncryption',
199199
'Enable-AzSqlInstanceAdvancedDataSecurity',
200200
'Disable-AzSqlInstanceAdvancedDataSecurity',
201201
'Get-AzSqlInstanceAdvancedDataSecurityPolicy',
202-
'Get-AzManagedDatabaseSensitivityClassification',
203-
'Set-AzManagedDatabaseSensitivityClassification',
204-
'Remove-AzManagedDatabaseSensitivityClassification',
205-
'Get-AzManagedDatabaseSensitivityRecommendations',
206202
'Get-AzSqlDatabaseSensitivityClassification',
203+
'Get-AzSqlInstanceDatabaseSensitivityClassification',
207204
'Set-AzSqlDatabaseSensitivityClassification',
205+
'Set-AzSqlInstanceDatabaseSensitivityClassification',
208206
'Remove-AzSqlDatabaseSensitivityClassification',
209-
'Get-AzSqlDatabaseSensitivityRecommendations'
207+
'Remove-AzSqlInstanceDatabaseSensitivityClassification',
208+
'Get-AzSqlDatabaseSensitivityRecommendations',
209+
'Get-AzSqlInstanceDatabaseSensitivityRecommendations'
210210

211211
# Variables to export from this module
212212
# VariablesToExport = @()

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ namespace Microsoft.Azure.Commands.Sql.DataClassification.Cmdlet
1111
{
1212
[Cmdlet(
1313
VerbsCommon.Get,
14-
ResourceManager.Common.AzureRMConstants.AzureRMPrefix + DefinitionsCommon.ManagedDatabaseSensitivityClassification),
14+
ResourceManager.Common.AzureRMConstants.AzureRMPrefix + DefinitionsCommon.SqlInstanceDatabaseSensitivityClassification),
1515
OutputType(typeof(ManagedDatabaseSensitivityClassificationModel))]
1616
public class GetAzSqlInstanceDatabaseSensitivityClassification : AzureSqlCmdletBase<ManagedDatabaseSensitivityClassificationModel, DataClassificationAdapter>
1717
{

‎src/Sql/Sql/DataClassification/Cmdlet/RemoveAzSqlInstanceDatabaseSensitivityClassification.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.Remove,
13-
ResourceManager.Common.AzureRMConstants.AzureRMPrefix + DefinitionsCommon.ManagedDatabaseSensitivityClassification,
13+
ResourceManager.Common.AzureRMConstants.AzureRMPrefix + DefinitionsCommon.SqlInstanceDatabaseSensitivityClassification,
1414
SupportsShouldProcess = true)]
1515
public class RemoveAzSqlInstanceDatabaseSensitivityClassification : AzureSqlCmdletBase<ManagedDatabaseSensitivityClassificationModel, DataClassificationAdapter>
1616
{

‎src/Sql/Sql/DataClassification/Cmdlet/SetAzSqlInstanceDatabaseSensitivityClassification.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.Set,
13-
ResourceManager.Common.AzureRMConstants.AzureRMPrefix + DefinitionsCommon.ManagedDatabaseSensitivityClassification,
13+
ResourceManager.Common.AzureRMConstants.AzureRMPrefix + DefinitionsCommon.SqlInstanceDatabaseSensitivityClassification,
1414
SupportsShouldProcess = true)]
1515
public class SetAzSqlInstanceDatabaseSensitivityClassification : AzureSqlCmdletBase<ManagedDatabaseSensitivityClassificationModel, DataClassificationAdapter>
1616
{

‎src/Sql/Sql/DataClassification/DefinitionsCommon.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ public class DefinitionsCommon
1111
internal const string ParentResourceParameterSet = "ParentResourceParameterSet";
1212
internal const string DatabaseParameterSet = "DatabaseParameterSet";
1313
internal const string SqlDatabaseSensitivityClassification = "SqlDatabaseSensitivityClassification";
14-
internal const string ManagedDatabaseSensitivityClassification = "ManagedDatabaseSensitivityClassification";
14+
internal const string SqlInstanceDatabaseSensitivityClassification = "SqlInstanceDatabaseSensitivityClassification";
1515
internal const string ResourceGroupNameHelpMessage = "The name of the resource group.";
1616
internal const string ServerNameHelpMessage = "SQL server name.";
1717
internal const string InstanceNameHelpMessage = "SQL Managed Instance name.";
18-
internal const string DatabaseNameHelpMessage = "SQL Database name.";
18+
internal const string DatabaseNameHelpMessage = "The name of the Azure SQL Database.";
1919
internal const string LabelNameHelpMessage = "A name that describes the sensitivity of the data stored in the column.";
2020
internal const string InformationTypeHelpMessage = "A name that describes the information type of the data stored in the column.";
21-
internal const string ManagedDatabaseNameHelpMessage = "SQL Managed Database name.";
21+
internal const string ManagedDatabaseNameHelpMessage = "The name of the Azure SQL Instance Database.";
2222
internal const string SqlDatabaseInputObjectHelpMessage = "The SQL database object.";
23-
internal const string ManagedDatabaseInputObjectHelpMessage = "The managed database object.";
23+
internal const string ManagedDatabaseInputObjectHelpMessage = "The SQL instance database object.";
2424
internal const string SqlDatabaseSensitivityClassificationInputObjectHelpMessage = "An object representing a SQL Database Sensitivity Classification.";
2525
internal const string ManagedDatabaseSensitivityClassificationInputObjectHelpMessage = "An object representing a SQL Managed Database Sensitivity Classification.";
2626
internal const string PassThruHelpMessage = "Specifies whether to output the sensitivity classification model at end of cmdlet execution";

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ SensitivityLabels : {{
6969
LabelName: label3,
7070
}}
7171
```
72+
7273
### Example 2: Get current sensitivity classification of an Azure SQL database.
7374
```powershell
7475
PS C:\> Get-AzSqlDatabase -ResourceGroupName resourceGroup -ServerName server -DatabaseName database | Get-AzSqlDatabaseSensitivityClassification
@@ -94,6 +95,7 @@ SensitivityLabels : {{
9495
LabelName: label3,
9596
}}
9697
```
98+
9799
### Example 3: Get current sensitivity classification of a specific column of an Azure SQL database.
98100
```powershell
99101
PS C:\> Get-AzSqlDatabaseSensitivityClassification -ResourceGroupName resourceGroup -ServerName server -DatabaseName database -SchemaName schema -TableName table -ColumnName column
@@ -109,6 +111,7 @@ SensitivityLabels : {{
109111
InformationType: informationType,
110112
}}
111113
```
114+
112115
### Example 4: Get current sensitivity classification of a specific column of an Azure SQL database.
113116
```powershell
114117
PS C:\> Get-AzSqlDatabase -ResourceGroupName resourceGroup -ServerName server -DatabaseName database | Get-AzSqlDatabaseSensitivityClassification -SchemaName schema -TableName table -ColumnName column
@@ -158,7 +161,7 @@ Accept wildcard characters: False
158161
```
159162
160163
### -DatabaseName
161-
SQL Database name.
164+
The name of the Azure SQL Database.
162165
163166
```yaml
164167
Type: System.String

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

Lines changed: 95 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
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/get-azmanageddatabasesensitivityclassification
5+
online version: https://docs.microsoft.com/en-us/powershell/module/az.sql/get-azsqlinstancedatabasesensitivityclassification
66
schema: 2.0.0
77
---
88

9-
# Get-AzManagedDatabaseSensitivityClassification
9+
# Get-AzSqlInstanceDatabaseSensitivityClassification
1010

1111
## SYNOPSIS
1212
Gets the current sensitivity labels and information types of columns in the database.
@@ -15,35 +15,119 @@ Gets the current sensitivity labels and information types of columns in the data
1515

1616
### DatabaseParameterSet
1717
```
18-
Get-AzManagedDatabaseSensitivityClassification [-ResourceGroupName] <String> [-InstanceName] <String>
18+
Get-AzSqlInstanceDatabaseSensitivityClassification [-ResourceGroupName] <String> [-InstanceName] <String>
1919
[-DatabaseName] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2020
```
2121

2222
### ColumnParameterSet
2323
```
24-
Get-AzManagedDatabaseSensitivityClassification [-ResourceGroupName] <String> [-InstanceName] <String>
24+
Get-AzSqlInstanceDatabaseSensitivityClassification [-ResourceGroupName] <String> [-InstanceName] <String>
2525
[-DatabaseName] <String> -SchemaName <String> -TableName <String> -ColumnName <String> [-AsJob]
2626
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2727
```
2828

2929
### ParentResourceParameterSet
3030
```
31-
Get-AzManagedDatabaseSensitivityClassification -InputObject <AzureSqlManagedDatabaseModel> [-AsJob]
31+
Get-AzSqlInstanceDatabaseSensitivityClassification -InputObject <AzureSqlManagedDatabaseModel> [-AsJob]
3232
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
3333
```
3434

3535
### ParentResourceColumnParameterSet
3636
```
37-
Get-AzManagedDatabaseSensitivityClassification -InputObject <AzureSqlManagedDatabaseModel> -SchemaName <String>
38-
-TableName <String> -ColumnName <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>]
39-
[<CommonParameters>]
37+
Get-AzSqlInstanceDatabaseSensitivityClassification -InputObject <AzureSqlManagedDatabaseModel>
38+
-SchemaName <String> -TableName <String> -ColumnName <String> [-AsJob]
39+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
4040
```
4141

4242
## DESCRIPTION
43-
The Get-AzManagedDatabaseSensitivityClassification cmdlet gets the current sensitivity labels and information types of columns in the database.
43+
The Get-AzSqlInstanceDatabaseSensitivityClassification cmdlet returns the current sensitivity labels and information types of columns in the database.
4444

4545
## EXAMPLES
4646

47+
### Example 1: Get current sensitivity classification of an Azure SQL Managed Instance database.
48+
```powershell
49+
PS C:\> Get-AzSqlInstanceDatabaseSensitivityClassification -ResourceGroupName resourceGroup -InstanceName managedInstance -DatabaseName database
50+
51+
ResourceGroupName : resourceGroup
52+
InstanceName : managedInstance
53+
DatabaseName : database
54+
SensitivityLabels : {{
55+
SchemaName: schema1,
56+
TableName: table1,
57+
ColumnName: column1,
58+
LabelName: label1,
59+
InformationType: informationType1,
60+
}, {
61+
SchemaName: schema2,
62+
TableName: table2,
63+
ColumnName: column2,
64+
LabelName: label2,
65+
}, {
66+
SchemaName: schema3,
67+
TableName: table3,
68+
ColumnName: column3,
69+
LabelName: label3,
70+
}}
71+
```
72+
73+
### Example 2: Get current sensitivity classification of an Azure SQL Managed Instance database.
74+
```powershell
75+
PS C:\> Get-AzSqlInstanceDatabase -ResourceGroupName resourceGroup -InstanceName managedInstance -Name database | Get-AzSqlInstanceDatabaseSensitivityClassification
76+
77+
ResourceGroupName : resourceGroup
78+
InstanceName : managedInstance
79+
DatabaseName : database
80+
SensitivityLabels : {{
81+
SchemaName: schema1,
82+
TableName: table1,
83+
ColumnName: column1,
84+
LabelName: label1,
85+
InformationType: informationType1,
86+
}, {
87+
SchemaName: schema2,
88+
TableName: table2,
89+
ColumnName: column2,
90+
LabelName: label2,
91+
}, {
92+
SchemaName: schema3,
93+
TableName: table3,
94+
ColumnName: column3,
95+
LabelName: label3,
96+
}}
97+
```
98+
99+
### Example 3: Get current sensitivity classification of a specific column of an Azure SQL Managed Instance database.
100+
```powershell
101+
PS C:\> Get-AzSqlInstanceDatabaseSensitivityClassification -ResourceGroupName resourceGroup -InstanceName managedInstance -DatabaseName database -SchemaName schema -TableName table -ColumnName column
102+
103+
ResourceGroupName : resourceGroup
104+
InstanceName : managedInstance
105+
DatabaseName : database
106+
SensitivityLabels : {{
107+
SchemaName: schema,
108+
TableName: table,
109+
ColumnName: column,
110+
LabelName: label,
111+
InformationType: informationType,
112+
}}
113+
```
114+
115+
### Example 4: Get current sensitivity classification of a specific column of an Azure SQL Managed Instance database.
116+
```powershell
117+
PS C:\> Get-AzSqlInstanceDatabase -ResourceGroupName resourceGroup -InstanceName managedInstance -Name database | Get-AzSqlInstanceDatabaseSensitivityClassification -SchemaName schema -TableName table -ColumnName column
118+
119+
ResourceGroupName : resourceGroup
120+
InstanceName : managedInstance
121+
DatabaseName : database
122+
SensitivityLabels : {{
123+
SchemaName: schema,
124+
TableName: table,
125+
ColumnName: column,
126+
LabelName: label,
127+
InformationType: informationType,
128+
}}
129+
```
130+
47131
## PARAMETERS
48132

49133
### -AsJob
@@ -77,7 +161,7 @@ Accept wildcard characters: False
77161
```
78162
79163
### -DatabaseName
80-
SQL Database name.
164+
The name of the Azure SQL Instance Database.
81165
82166
```yaml
83167
Type: System.String
@@ -107,7 +191,7 @@ Accept wildcard characters: False
107191
```
108192
109193
### -InputObject
110-
An object representing a SQL Database Sensitivity Classification
194+
The SQL instance database object.
111195
112196
```yaml
113197
Type: Microsoft.Azure.Commands.Sql.ManagedDatabase.Model.AzureSqlManagedDatabaseModel

0 commit comments

Comments
 (0)