-
Notifications
You must be signed in to change notification settings - Fork 180
/
ServerDevOpsAuditingSettings.yml
200 lines (182 loc) · 6.45 KB
/
ServerDevOpsAuditingSettings.yml
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
### YamlMime:TSType
name: ServerDevOpsAuditingSettings
uid: '@azure/arm-sql.ServerDevOpsAuditingSettings'
package: '@azure/arm-sql'
summary: A server DevOps auditing settings.
fullName: ServerDevOpsAuditingSettings
remarks: ''
isDeprecated: false
type: interface
properties:
- name: isAzureMonitorTargetEnabled
uid: '@azure/arm-sql.ServerDevOpsAuditingSettings.isAzureMonitorTargetEnabled'
package: '@azure/arm-sql'
summary: >-
Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with
'DevOpsOperationsAudit' diagnostic logs category on the master database
should be also created.
Diagnostic Settings URI format:
PUT
https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/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)
fullName: isAzureMonitorTargetEnabled
remarks: ''
isDeprecated: false
syntax:
content: 'isAzureMonitorTargetEnabled?: boolean'
return:
description: ''
type: boolean
- name: isManagedIdentityInUse
uid: '@azure/arm-sql.ServerDevOpsAuditingSettings.isManagedIdentityInUse'
package: '@azure/arm-sql'
summary: Specifies whether Managed Identity is used to access blob storage
fullName: isManagedIdentityInUse
remarks: ''
isDeprecated: false
syntax:
content: 'isManagedIdentityInUse?: boolean'
return:
description: ''
type: boolean
- name: state
uid: '@azure/arm-sql.ServerDevOpsAuditingSettings.state'
package: '@azure/arm-sql'
summary: >-
Specifies the state of the audit. If state is Enabled, storageEndpoint or
isAzureMonitorTargetEnabled are required.
fullName: state
remarks: ''
isDeprecated: false
syntax:
content: 'state?: BlobAuditingPolicyState'
return:
description: ''
type: <xref uid="@azure/arm-sql.BlobAuditingPolicyState" />
- name: storageAccountAccessKey
uid: '@azure/arm-sql.ServerDevOpsAuditingSettings.storageAccountAccessKey'
package: '@azure/arm-sql'
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)
fullName: storageAccountAccessKey
remarks: ''
isDeprecated: false
syntax:
content: 'storageAccountAccessKey?: string'
return:
description: ''
type: string
- name: storageAccountSubscriptionId
uid: '@azure/arm-sql.ServerDevOpsAuditingSettings.storageAccountSubscriptionId'
package: '@azure/arm-sql'
summary: Specifies the blob storage subscription Id.
fullName: storageAccountSubscriptionId
remarks: ''
isDeprecated: false
syntax:
content: 'storageAccountSubscriptionId?: string'
return:
description: ''
type: string
- name: storageEndpoint
uid: '@azure/arm-sql.ServerDevOpsAuditingSettings.storageEndpoint'
package: '@azure/arm-sql'
summary: >-
Specifies the blob storage endpoint (e.g.
https://MyAccount.blob.core.windows.net). If state is Enabled,
storageEndpoint or isAzureMonitorTargetEnabled is required.
fullName: storageEndpoint
remarks: ''
isDeprecated: false
syntax:
content: 'storageEndpoint?: string'
return:
description: ''
type: string
- name: systemData
uid: '@azure/arm-sql.ServerDevOpsAuditingSettings.systemData'
package: '@azure/arm-sql'
summary: >-
SystemData of ServerDevOpsAuditSettingsResource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: systemData
remarks: ''
isDeprecated: false
syntax:
content: 'systemData?: SystemData'
return:
description: ''
type: <xref uid="@azure/arm-sql.SystemData" />
inheritedProperties:
- name: id
uid: '@azure/arm-sql.ServerDevOpsAuditingSettings.id'
package: '@azure/arm-sql'
summary: >-
Resource ID.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.id](xref:@azure/arm-sql.ProxyResource.id)
- name: name
uid: '@azure/arm-sql.ServerDevOpsAuditingSettings.name'
package: '@azure/arm-sql'
summary: >-
Resource name.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.name](xref:@azure/arm-sql.ProxyResource.name)
- name: type
uid: '@azure/arm-sql.ServerDevOpsAuditingSettings.type'
package: '@azure/arm-sql'
summary: >-
Resource type.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.type](xref:@azure/arm-sql.ProxyResource.type)
extends: <xref uid="@azure/arm-sql.ProxyResource" />