/
PolicyState.yml
447 lines (444 loc) · 13.9 KB
/
PolicyState.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
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
### YamlMime:TSType
name: PolicyState
uid: '@azure/arm-policyinsights.PolicyState'
package: '@azure/arm-policyinsights'
summary: Policy state record.
fullName: PolicyState
remarks: ''
isDeprecated: false
type: interface
properties:
- name: complianceState
uid: '@azure/arm-policyinsights.PolicyState.complianceState'
package: '@azure/arm-policyinsights'
summary: Compliance state of the resource.
fullName: complianceState
remarks: ''
isDeprecated: false
syntax:
content: 'complianceState?: string'
return:
description: ''
type: string
- name: components
uid: '@azure/arm-policyinsights.PolicyState.components'
package: '@azure/arm-policyinsights'
summary: >-
Components state compliance records populated only when URL contains
$expand=components clause.
fullName: components
remarks: ''
isDeprecated: false
syntax:
content: 'components?: ComponentStateDetails[]'
return:
description: ''
type: <xref uid="@azure/arm-policyinsights.ComponentStateDetails" />[]
- name: effectiveParameters
uid: '@azure/arm-policyinsights.PolicyState.effectiveParameters'
package: '@azure/arm-policyinsights'
summary: Effective parameters for the policy assignment.
fullName: effectiveParameters
remarks: ''
isDeprecated: false
syntax:
content: 'effectiveParameters?: string'
return:
description: ''
type: string
- name: isCompliant
uid: '@azure/arm-policyinsights.PolicyState.isCompliant'
package: '@azure/arm-policyinsights'
summary: >-
Flag which states whether the resource is compliant against the policy
assignment it was evaluated against. This property is deprecated; please
use ComplianceState instead.
fullName: isCompliant
remarks: ''
isDeprecated: false
syntax:
content: 'isCompliant?: boolean'
return:
description: ''
type: boolean
- name: managementGroupIds
uid: '@azure/arm-policyinsights.PolicyState.managementGroupIds'
package: '@azure/arm-policyinsights'
summary: >-
Comma separated list of management group IDs, which represent the
hierarchy of the management groups the resource is under.
fullName: managementGroupIds
remarks: ''
isDeprecated: false
syntax:
content: 'managementGroupIds?: string'
return:
description: ''
type: string
- name: odataContext
uid: '@azure/arm-policyinsights.PolicyState.odataContext'
package: '@azure/arm-policyinsights'
summary: >-
OData context string; used by OData clients to resolve type information
based on metadata.
fullName: odataContext
remarks: ''
isDeprecated: false
syntax:
content: 'odataContext?: string'
return:
description: ''
type: string
- name: odataId
uid: '@azure/arm-policyinsights.PolicyState.odataId'
package: '@azure/arm-policyinsights'
summary: >-
OData entity ID; always set to null since policy state records do not have
an entity ID.
fullName: odataId
remarks: ''
isDeprecated: false
syntax:
content: 'odataId?: string'
return:
description: ''
type: string
- name: policyAssignmentId
uid: '@azure/arm-policyinsights.PolicyState.policyAssignmentId'
package: '@azure/arm-policyinsights'
summary: Policy assignment ID.
fullName: policyAssignmentId
remarks: ''
isDeprecated: false
syntax:
content: 'policyAssignmentId?: string'
return:
description: ''
type: string
- name: policyAssignmentName
uid: '@azure/arm-policyinsights.PolicyState.policyAssignmentName'
package: '@azure/arm-policyinsights'
summary: Policy assignment name.
fullName: policyAssignmentName
remarks: ''
isDeprecated: false
syntax:
content: 'policyAssignmentName?: string'
return:
description: ''
type: string
- name: policyAssignmentOwner
uid: '@azure/arm-policyinsights.PolicyState.policyAssignmentOwner'
package: '@azure/arm-policyinsights'
summary: Policy assignment owner.
fullName: policyAssignmentOwner
remarks: ''
isDeprecated: false
syntax:
content: 'policyAssignmentOwner?: string'
return:
description: ''
type: string
- name: policyAssignmentParameters
uid: '@azure/arm-policyinsights.PolicyState.policyAssignmentParameters'
package: '@azure/arm-policyinsights'
summary: Policy assignment parameters.
fullName: policyAssignmentParameters
remarks: ''
isDeprecated: false
syntax:
content: 'policyAssignmentParameters?: string'
return:
description: ''
type: string
- name: policyAssignmentScope
uid: '@azure/arm-policyinsights.PolicyState.policyAssignmentScope'
package: '@azure/arm-policyinsights'
summary: Policy assignment scope.
fullName: policyAssignmentScope
remarks: ''
isDeprecated: false
syntax:
content: 'policyAssignmentScope?: string'
return:
description: ''
type: string
- name: policyAssignmentVersion
uid: '@azure/arm-policyinsights.PolicyState.policyAssignmentVersion'
package: '@azure/arm-policyinsights'
summary: >-
Evaluated policy assignment version.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: policyAssignmentVersion
remarks: ''
isDeprecated: false
syntax:
content: 'policyAssignmentVersion?: string'
return:
description: ''
type: string
- name: policyDefinitionAction
uid: '@azure/arm-policyinsights.PolicyState.policyDefinitionAction'
package: '@azure/arm-policyinsights'
summary: Policy definition action, i.e. effect.
fullName: policyDefinitionAction
remarks: ''
isDeprecated: false
syntax:
content: 'policyDefinitionAction?: string'
return:
description: ''
type: string
- name: policyDefinitionCategory
uid: '@azure/arm-policyinsights.PolicyState.policyDefinitionCategory'
package: '@azure/arm-policyinsights'
summary: Policy definition category.
fullName: policyDefinitionCategory
remarks: ''
isDeprecated: false
syntax:
content: 'policyDefinitionCategory?: string'
return:
description: ''
type: string
- name: policyDefinitionGroupNames
uid: '@azure/arm-policyinsights.PolicyState.policyDefinitionGroupNames'
package: '@azure/arm-policyinsights'
summary: Policy definition group names.
fullName: policyDefinitionGroupNames
remarks: ''
isDeprecated: false
syntax:
content: 'policyDefinitionGroupNames?: string[]'
return:
description: ''
type: string[]
- name: policyDefinitionId
uid: '@azure/arm-policyinsights.PolicyState.policyDefinitionId'
package: '@azure/arm-policyinsights'
summary: Policy definition ID.
fullName: policyDefinitionId
remarks: ''
isDeprecated: false
syntax:
content: 'policyDefinitionId?: string'
return:
description: ''
type: string
- name: policyDefinitionName
uid: '@azure/arm-policyinsights.PolicyState.policyDefinitionName'
package: '@azure/arm-policyinsights'
summary: Policy definition name.
fullName: policyDefinitionName
remarks: ''
isDeprecated: false
syntax:
content: 'policyDefinitionName?: string'
return:
description: ''
type: string
- name: policyDefinitionReferenceId
uid: '@azure/arm-policyinsights.PolicyState.policyDefinitionReferenceId'
package: '@azure/arm-policyinsights'
summary: >-
Reference ID for the policy definition inside the policy set, if the
policy assignment is for a policy set.
fullName: policyDefinitionReferenceId
remarks: ''
isDeprecated: false
syntax:
content: 'policyDefinitionReferenceId?: string'
return:
description: ''
type: string
- name: policyDefinitionVersion
uid: '@azure/arm-policyinsights.PolicyState.policyDefinitionVersion'
package: '@azure/arm-policyinsights'
summary: >-
Evaluated policy definition version.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: policyDefinitionVersion
remarks: ''
isDeprecated: false
syntax:
content: 'policyDefinitionVersion?: string'
return:
description: ''
type: string
- name: policyEvaluationDetails
uid: '@azure/arm-policyinsights.PolicyState.policyEvaluationDetails'
package: '@azure/arm-policyinsights'
summary: Policy evaluation details.
fullName: policyEvaluationDetails
remarks: ''
isDeprecated: false
syntax:
content: 'policyEvaluationDetails?: PolicyEvaluationDetails'
return:
description: ''
type: <xref uid="@azure/arm-policyinsights.PolicyEvaluationDetails" />
- name: policySetDefinitionCategory
uid: '@azure/arm-policyinsights.PolicyState.policySetDefinitionCategory'
package: '@azure/arm-policyinsights'
summary: >-
Policy set definition category, if the policy assignment is for a policy
set.
fullName: policySetDefinitionCategory
remarks: ''
isDeprecated: false
syntax:
content: 'policySetDefinitionCategory?: string'
return:
description: ''
type: string
- name: policySetDefinitionId
uid: '@azure/arm-policyinsights.PolicyState.policySetDefinitionId'
package: '@azure/arm-policyinsights'
summary: Policy set definition ID, if the policy assignment is for a policy set.
fullName: policySetDefinitionId
remarks: ''
isDeprecated: false
syntax:
content: 'policySetDefinitionId?: string'
return:
description: ''
type: string
- name: policySetDefinitionName
uid: '@azure/arm-policyinsights.PolicyState.policySetDefinitionName'
package: '@azure/arm-policyinsights'
summary: Policy set definition name, if the policy assignment is for a policy set.
fullName: policySetDefinitionName
remarks: ''
isDeprecated: false
syntax:
content: 'policySetDefinitionName?: string'
return:
description: ''
type: string
- name: policySetDefinitionOwner
uid: '@azure/arm-policyinsights.PolicyState.policySetDefinitionOwner'
package: '@azure/arm-policyinsights'
summary: Policy set definition owner, if the policy assignment is for a policy set.
fullName: policySetDefinitionOwner
remarks: ''
isDeprecated: false
syntax:
content: 'policySetDefinitionOwner?: string'
return:
description: ''
type: string
- name: policySetDefinitionParameters
uid: '@azure/arm-policyinsights.PolicyState.policySetDefinitionParameters'
package: '@azure/arm-policyinsights'
summary: >-
Policy set definition parameters, if the policy assignment is for a policy
set.
fullName: policySetDefinitionParameters
remarks: ''
isDeprecated: false
syntax:
content: 'policySetDefinitionParameters?: string'
return:
description: ''
type: string
- name: policySetDefinitionVersion
uid: '@azure/arm-policyinsights.PolicyState.policySetDefinitionVersion'
package: '@azure/arm-policyinsights'
summary: >-
Evaluated policy set definition version.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: policySetDefinitionVersion
remarks: ''
isDeprecated: false
syntax:
content: 'policySetDefinitionVersion?: string'
return:
description: ''
type: string
- name: resourceGroup
uid: '@azure/arm-policyinsights.PolicyState.resourceGroup'
package: '@azure/arm-policyinsights'
summary: Resource group name.
fullName: resourceGroup
remarks: ''
isDeprecated: false
syntax:
content: 'resourceGroup?: string'
return:
description: ''
type: string
- name: resourceId
uid: '@azure/arm-policyinsights.PolicyState.resourceId'
package: '@azure/arm-policyinsights'
summary: Resource ID.
fullName: resourceId
remarks: ''
isDeprecated: false
syntax:
content: 'resourceId?: string'
return:
description: ''
type: string
- name: resourceLocation
uid: '@azure/arm-policyinsights.PolicyState.resourceLocation'
package: '@azure/arm-policyinsights'
summary: Resource location.
fullName: resourceLocation
remarks: ''
isDeprecated: false
syntax:
content: 'resourceLocation?: string'
return:
description: ''
type: string
- name: resourceTags
uid: '@azure/arm-policyinsights.PolicyState.resourceTags'
package: '@azure/arm-policyinsights'
summary: List of resource tags.
fullName: resourceTags
remarks: ''
isDeprecated: false
syntax:
content: 'resourceTags?: string'
return:
description: ''
type: string
- name: resourceType
uid: '@azure/arm-policyinsights.PolicyState.resourceType'
package: '@azure/arm-policyinsights'
summary: Resource type.
fullName: resourceType
remarks: ''
isDeprecated: false
syntax:
content: 'resourceType?: string'
return:
description: ''
type: string
- name: subscriptionId
uid: '@azure/arm-policyinsights.PolicyState.subscriptionId'
package: '@azure/arm-policyinsights'
summary: Subscription ID.
fullName: subscriptionId
remarks: ''
isDeprecated: false
syntax:
content: 'subscriptionId?: string'
return:
description: ''
type: string
- name: timestamp
uid: '@azure/arm-policyinsights.PolicyState.timestamp'
package: '@azure/arm-policyinsights'
summary: Timestamp for the policy state record.
fullName: timestamp
remarks: ''
isDeprecated: false
syntax:
content: 'timestamp?: Date'
return:
description: ''
type: Date