Skip to content

Commit a716374

Browse files
committed
Updating datasecurity cmdlets help
Updating datasecurity cmdlets help
1 parent 24de60a commit a716374

21 files changed

+2345
-2075
lines changed

src/ResourceManager/Sql/Commands.Sql/Microsoft.Azure.Commands.Sql.dll-Help.xml

Lines changed: 1243 additions & 1100 deletions
Large diffs are not rendered by default.

src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditingPolicy.md

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,27 +22,41 @@ Get-AzureRmSqlDatabaseAuditingPolicy [-ServerName] <String> [-DatabaseName] <Str
2222
The **Get-AzureRmSqlDatabaseAuditingPolicy** cmdlet gets the auditing policy of an Azure SQL Database.
2323
To use the cmdlet, use the *ResourceGroupName*, *ServerName*, and *DatabaseName* parameters to identify the database.
2424

25-
This cmdlet is also supported by the SQL Server Stretch Database service on Azure.
2625

2726
## EXAMPLES
2827

29-
### Example 1: Get the auditing policy of an Azure SQL database
28+
### Example 1: Get the auditing policy of an Azure SQL database with Table auditing defined on it
3029
```
3130
PS C:\>Get-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"
32-
DatabaseName : database01
33-
UseServerDefault : Disabled
34-
ResourceGroupName : resourcegroup01
35-
ServerName : server01
36-
StorageAccountName :
37-
StorageKeyType : Primary
38-
EventType : {PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure...}
39-
AuditState : New
40-
RetentionInDays : 0
41-
TableIdentifier : Server01Database01
42-
AuditType : Table
31+
DatabaseName : database01
32+
UseServerDefault : Disabled
33+
EventType : {PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure...}
34+
TableIdentifier : MyAuditTableName
35+
FullAuditLogsTableName : SQLDBAuditLogsMyAuditTableName
36+
ResourceGroupName : resourcegroup01
37+
ServerName : server01
38+
AuditType : Table
39+
AuditState : Enabled
40+
StorageAccountName : mystorage
41+
StorageKeyType : Primary
42+
RetentionInDays : 0
4343
```
4444

45-
This command gets the auditing policy of database Database01 located in Server01 in resource group ResourceGroup01.
45+
### Example 2: Get the auditing policy of an Azure SQL database with Blob auditing defined on it
46+
```
47+
PS C:\>Get-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"
48+
DatabaseName : database01
49+
AuditAction : {}
50+
AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP,
51+
BATCH_COMPLETED_GROUP, ...}
52+
ResourceGroupName : resourcegroup01
53+
ServerName : server01
54+
AuditType : Blob
55+
AuditState : Enabled
56+
StorageAccountName : mystorage
57+
StorageKeyType : Primary
58+
RetentionInDays : 0
59+
```
4660

4761
## PARAMETERS
4862

src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingPolicy.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,6 @@ This command gets the data masking policy from database Database01 in resource g
4040

4141
## PARAMETERS
4242

43-
### -ServerName
44-
Specifies the name of the server where the database is located.
45-
46-
```yaml
47-
Type: String
48-
Parameter Sets: (All)
49-
Aliases:
50-
51-
Required: True
52-
Position: 1
53-
Default value: None
54-
Accept pipeline input: True (ByPropertyName)
55-
Accept wildcard characters: False
56-
```
57-
5843
### -DatabaseName
5944
Specifies the name of the database.
6045

@@ -70,21 +55,6 @@ Accept pipeline input: True (ByPropertyName)
7055
Accept wildcard characters: False
7156
```
7257
73-
### -ResourceGroupName
74-
Specifies the name of the resource group to which the database is assigned.
75-
76-
```yaml
77-
Type: String
78-
Parameter Sets: (All)
79-
Aliases:
80-
81-
Required: True
82-
Position: 0
83-
Default value: None
84-
Accept pipeline input: True (ByPropertyName)
85-
Accept wildcard characters: False
86-
```
87-
8858
### -InformationAction
8959
Specifies how this cmdlet responds to an information event.
9060
@@ -124,6 +94,36 @@ Accept pipeline input: False
12494
Accept wildcard characters: False
12595
```
12696
97+
### -ResourceGroupName
98+
Specifies the name of the resource group to which the database is assigned.
99+
100+
```yaml
101+
Type: String
102+
Parameter Sets: (All)
103+
Aliases:
104+
105+
Required: True
106+
Position: 0
107+
Default value: None
108+
Accept pipeline input: True (ByPropertyName)
109+
Accept wildcard characters: False
110+
```
111+
112+
### -ServerName
113+
Specifies the name of the server where the database is located.
114+
115+
```yaml
116+
Type: String
117+
Parameter Sets: (All)
118+
Aliases:
119+
120+
Required: True
121+
Position: 1
122+
Default value: None
123+
Accept pipeline input: True (ByPropertyName)
124+
Accept wildcard characters: False
125+
```
126+
127127
### -Confirm
128128
Prompts you for confirmation before running the cmdlet.
129129

src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingRule.md

Lines changed: 87 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,56 @@ This cmdlet is also supported by the SQL Server Stretch Database service on Azur
3131
### Example 1: Get all data masking rules from a database
3232
```
3333
PS C:\>Get-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"
34+
DatabaseName : database01
35+
ResourceGroupName : resourcegroup01
36+
ServerName : server01
37+
SchemaName : dbo
38+
TableName : table1
39+
ColumnName : column1
40+
MaskingFunction : Default
41+
PrefixSize :
42+
SuffixSize :
43+
ReplacementString :
44+
NumberFrom :
45+
NumberTo :
46+
47+
DatabaseName : database01
48+
ResourceGroupName : resourcegroup01
49+
ServerName : server01
50+
SchemaName : dbo
51+
TableName : table2
52+
ColumnName : column2
53+
MaskingFunction : Default
54+
PrefixSize :
55+
SuffixSize :
56+
ReplacementString :
57+
NumberFrom :
58+
NumberTo :
59+
3460
```
3561

36-
This command gets all data masking rules from Database01 in resource group ResourceGroup01 found on server Server01.
62+
63+
### Example 2: Get the data masking rule defined on schema "dbo", table "table1" and column "column1".
64+
```
65+
PS C:\>Get-AzureRmSqlDatabaseDataMaskingRule -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" -SchemaName "dbo" -TableName "table1" -ColumnName "column1"
66+
DatabaseName : database01
67+
ResourceGroupName : resourcegroup01
68+
ServerName : server01
69+
SchemaName : dbo
70+
TableName : table1
71+
ColumnName : column1
72+
MaskingFunction : Default
73+
PrefixSize :
74+
SuffixSize :
75+
ReplacementString :
76+
NumberFrom :
77+
NumberTo :
78+
```
3779

3880
## PARAMETERS
3981

40-
### -SchemaName
41-
Specifies the name of a schema.
82+
### -ColumnName
83+
Specifies the name of the column targeted by the masking rule.
4284

4385
```yaml
4486
Type: String
@@ -52,117 +94,117 @@ Accept pipeline input: True (ByPropertyName)
5294
Accept wildcard characters: False
5395
```
5496
55-
### -TableName
56-
Specifies the name of an Azure SQL table.
97+
### -DatabaseName
98+
Specifies the name of the database.
5799
58100
```yaml
59101
Type: String
60102
Parameter Sets: (All)
61103
Aliases:
62104

63-
Required: False
64-
Position: Named
105+
Required: True
106+
Position: 2
65107
Default value: None
66108
Accept pipeline input: True (ByPropertyName)
67109
Accept wildcard characters: False
68110
```
69111
70-
### -ColumnName
71-
Specifies the name of the column targeted by the masking rule.
112+
### -InformationAction
113+
Specifies how this cmdlet responds to an information event.
114+
115+
The acceptable values for this parameter are:
116+
117+
- Continue
118+
- Ignore
119+
- Inquire
120+
- SilentlyContinue
121+
- Stop
122+
- Suspend
72123
73124
```yaml
74-
Type: String
125+
Type: ActionPreference
75126
Parameter Sets: (All)
76-
Aliases:
127+
Aliases: infa
77128

78129
Required: False
79130
Position: Named
80131
Default value: None
81-
Accept pipeline input: True (ByPropertyName)
132+
Accept pipeline input: False
82133
Accept wildcard characters: False
83134
```
84135
85-
### -ServerName
86-
Specifies the name of the server.
136+
### -InformationVariable
137+
Specifies an information variable.
87138
88139
```yaml
89140
Type: String
90141
Parameter Sets: (All)
91-
Aliases:
142+
Aliases: iv
92143

93-
Required: True
94-
Position: 1
144+
Required: False
145+
Position: Named
95146
Default value: None
96-
Accept pipeline input: True (ByPropertyName)
147+
Accept pipeline input: False
97148
Accept wildcard characters: False
98149
```
99150
100-
### -DatabaseName
101-
Specifies the name of the database.
151+
### -ResourceGroupName
152+
Specifies the name of the resource group to which the database is assigned.
102153
103154
```yaml
104155
Type: String
105156
Parameter Sets: (All)
106157
Aliases:
107158

108159
Required: True
109-
Position: 2
160+
Position: 0
110161
Default value: None
111162
Accept pipeline input: True (ByPropertyName)
112163
Accept wildcard characters: False
113164
```
114165
115-
### -ResourceGroupName
116-
Specifies the name of the resource group to which the database is assigned.
166+
### -SchemaName
167+
Specifies the name of a schema.
117168
118169
```yaml
119170
Type: String
120171
Parameter Sets: (All)
121172
Aliases:
122173

123-
Required: True
124-
Position: 0
174+
Required: False
175+
Position: Named
125176
Default value: None
126177
Accept pipeline input: True (ByPropertyName)
127178
Accept wildcard characters: False
128179
```
129180
130-
### -InformationAction
131-
Specifies how this cmdlet responds to an information event.
132-
133-
The acceptable values for this parameter are:
134-
135-
- Continue
136-
- Ignore
137-
- Inquire
138-
- SilentlyContinue
139-
- Stop
140-
- Suspend
181+
### -ServerName
182+
Specifies the name of the server.
141183
142184
```yaml
143-
Type: ActionPreference
185+
Type: String
144186
Parameter Sets: (All)
145-
Aliases: infa
187+
Aliases:
146188

147-
Required: False
148-
Position: Named
189+
Required: True
190+
Position: 1
149191
Default value: None
150-
Accept pipeline input: False
192+
Accept pipeline input: True (ByPropertyName)
151193
Accept wildcard characters: False
152194
```
153195
154-
### -InformationVariable
155-
Specifies an information variable.
196+
### -TableName
197+
Specifies the name of an Azure SQL table.
156198
157199
```yaml
158200
Type: String
159201
Parameter Sets: (All)
160-
Aliases: iv
202+
Aliases:
161203

162204
Required: False
163205
Position: Named
164206
Default value: None
165-
Accept pipeline input: False
207+
Accept pipeline input: True (ByPropertyName)
166208
Accept wildcard characters: False
167209
```
168210

0 commit comments

Comments
 (0)