-
Notifications
You must be signed in to change notification settings - Fork 260
/
SynapseExtendedSqlPoolBlobAuditingPolicyData.xml
324 lines (308 loc) · 20.1 KB
/
SynapseExtendedSqlPoolBlobAuditingPolicyData.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
<Type Name="SynapseExtendedSqlPoolBlobAuditingPolicyData" FullName="Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData">
<TypeSignature Language="C#" Value="public class SynapseExtendedSqlPoolBlobAuditingPolicyData : Azure.ResourceManager.Models.ResourceData" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SynapseExtendedSqlPoolBlobAuditingPolicyData extends Azure.ResourceManager.Models.ResourceData" />
<TypeSignature Language="DocId" Value="T:Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData" />
<TypeSignature Language="VB.NET" Value="Public Class SynapseExtendedSqlPoolBlobAuditingPolicyData
Inherits ResourceData" />
<TypeSignature Language="F#" Value="type SynapseExtendedSqlPoolBlobAuditingPolicyData = class
 inherit ResourceData" />
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Synapse</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.1.1.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.ResourceManager.Models.ResourceData</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A class representing the SynapseExtendedSqlPoolBlobAuditingPolicy data model.
An extended Sql pool blob auditing policy.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SynapseExtendedSqlPoolBlobAuditingPolicyData ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Synapse</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of <see cref="T:Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData" />. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuditActionsAndGroups">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> AuditActionsAndGroups { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> AuditActionsAndGroups" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.AuditActionsAndGroups" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AuditActionsAndGroups As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.AuditActionsAndGroups : System.Collections.Generic.IList<string>" Usage="Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.AuditActionsAndGroups" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Synapse</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies the Actions-Groups and Actions to audit.
The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:
BATCH_COMPLETED_GROUP,
SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
FAILED_DATABASE_AUTHENTICATION_GROUP.
This above combination is also the set that is configured by default when enabling auditing from the Azure portal.
The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):
APPLICATION_ROLE_CHANGE_PASSWORD_GROUP
BACKUP_RESTORE_GROUP
DATABASE_LOGOUT_GROUP
DATABASE_OBJECT_CHANGE_GROUP
DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP
DATABASE_OBJECT_PERMISSION_CHANGE_GROUP
DATABASE_OPERATION_GROUP
DATABASE_PERMISSION_CHANGE_GROUP
DATABASE_PRINCIPAL_CHANGE_GROUP
DATABASE_PRINCIPAL_IMPERSONATION_GROUP
DATABASE_ROLE_MEMBER_CHANGE_GROUP
FAILED_DATABASE_AUTHENTICATION_GROUP
SCHEMA_OBJECT_ACCESS_GROUP
SCHEMA_OBJECT_CHANGE_GROUP
SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP
SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP
SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP
USER_CHANGE_PASSWORD_GROUP
BATCH_STARTED_GROUP
BATCH_COMPLETED_GROUP
These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.
For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).
For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:
SELECT
UPDATE
INSERT
DELETE
EXECUTE
RECEIVE
REFERENCES
The general form for defining an action to be audited is:
{action} ON {object} BY {principal}
Note that <object> in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.
For example:
SELECT on dbo.myTable by public
SELECT on DATABASE::myDatabase by public
SELECT on SCHEMA::mySchema by public
For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsAzureMonitorTargetEnabled">
<MemberSignature Language="C#" Value="public bool? IsAzureMonitorTargetEnabled { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> IsAzureMonitorTargetEnabled" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.IsAzureMonitorTargetEnabled" />
<MemberSignature Language="VB.NET" Value="Public Property IsAzureMonitorTargetEnabled As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsAzureMonitorTargetEnabled : Nullable<bool> with get, set" Usage="Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.IsAzureMonitorTargetEnabled" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Synapse</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies whether audit events are sent to Azure Monitor.
In order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.
When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.
Note that for server level audit you should use the 'master' database as {databaseName}.
Diagnostic Settings URI format:
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview
For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)
or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsStorageSecondaryKeyInUse">
<MemberSignature Language="C#" Value="public bool? IsStorageSecondaryKeyInUse { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> IsStorageSecondaryKeyInUse" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.IsStorageSecondaryKeyInUse" />
<MemberSignature Language="VB.NET" Value="Public Property IsStorageSecondaryKeyInUse As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsStorageSecondaryKeyInUse : Nullable<bool> with get, set" Usage="Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.IsStorageSecondaryKeyInUse" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Synapse</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary> Specifies whether storageAccountAccessKey value is the storage's secondary key. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PredicateExpression">
<MemberSignature Language="C#" Value="public string PredicateExpression { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PredicateExpression" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.PredicateExpression" />
<MemberSignature Language="VB.NET" Value="Public Property PredicateExpression As String" />
<MemberSignature Language="F#" Value="member this.PredicateExpression : string with get, set" Usage="Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.PredicateExpression" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Synapse</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> Specifies condition of where clause when creating an audit. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="QueueDelayMs">
<MemberSignature Language="C#" Value="public int? QueueDelayMs { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> QueueDelayMs" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.QueueDelayMs" />
<MemberSignature Language="VB.NET" Value="Public Property QueueDelayMs As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.QueueDelayMs : Nullable<int> with get, set" Usage="Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.QueueDelayMs" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Synapse</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.
The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RetentionDays">
<MemberSignature Language="C#" Value="public int? RetentionDays { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> RetentionDays" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.RetentionDays" />
<MemberSignature Language="VB.NET" Value="Public Property RetentionDays As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.RetentionDays : Nullable<int> with get, set" Usage="Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.RetentionDays" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Synapse</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary> Specifies the number of days to keep in the audit logs in the storage account. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="State">
<MemberSignature Language="C#" Value="public Azure.ResourceManager.Synapse.Models.SynapseBlobAuditingPolicyState? State { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.ResourceManager.Synapse.Models.SynapseBlobAuditingPolicyState> State" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.State" />
<MemberSignature Language="VB.NET" Value="Public Property State As Nullable(Of SynapseBlobAuditingPolicyState)" />
<MemberSignature Language="F#" Value="member this.State : Nullable<Azure.ResourceManager.Synapse.Models.SynapseBlobAuditingPolicyState> with get, set" Usage="Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.State" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Synapse</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.ResourceManager.Synapse.Models.SynapseBlobAuditingPolicyState></ReturnType>
</ReturnValue>
<Docs>
<summary> Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StorageAccountAccessKey">
<MemberSignature Language="C#" Value="public string StorageAccountAccessKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string StorageAccountAccessKey" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.StorageAccountAccessKey" />
<MemberSignature Language="VB.NET" Value="Public Property StorageAccountAccessKey As String" />
<MemberSignature Language="F#" Value="member this.StorageAccountAccessKey : string with get, set" Usage="Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.StorageAccountAccessKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Synapse</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies the identifier key of the auditing storage account.
If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.
Prerequisites for using managed identity authentication:
1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).
2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.
For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StorageAccountSubscriptionId">
<MemberSignature Language="C#" Value="public Guid? StorageAccountSubscriptionId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.Guid> StorageAccountSubscriptionId" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.StorageAccountSubscriptionId" />
<MemberSignature Language="VB.NET" Value="Public Property StorageAccountSubscriptionId As Nullable(Of Guid)" />
<MemberSignature Language="F#" Value="member this.StorageAccountSubscriptionId : Nullable<Guid> with get, set" Usage="Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.StorageAccountSubscriptionId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Synapse</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Guid></ReturnType>
</ReturnValue>
<Docs>
<summary> Specifies the blob storage subscription Id. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StorageEndpoint">
<MemberSignature Language="C#" Value="public string StorageEndpoint { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string StorageEndpoint" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.StorageEndpoint" />
<MemberSignature Language="VB.NET" Value="Public Property StorageEndpoint As String" />
<MemberSignature Language="F#" Value="member this.StorageEndpoint : string with get, set" Usage="Azure.ResourceManager.Synapse.SynapseExtendedSqlPoolBlobAuditingPolicyData.StorageEndpoint" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Synapse</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>