-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
policyDefinitions.json
697 lines (697 loc) · 24.6 KB
/
policyDefinitions.json
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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
{
"swagger": "2.0",
"info": {
"title": "PolicyClient",
"version": "2020-09-01",
"description": "To manage and control access to your resources, you can define customized policies and assign them at a scope."
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}": {
"put": {
"tags": [
"PolicyDefinitions"
],
"operationId": "PolicyDefinitions_CreateOrUpdate",
"summary": "Creates or updates a policy definition in a subscription.",
"description": "This operation creates or updates a policy definition in the given subscription with the given name.",
"x-ms-examples": {
"Create or update a policy definition": {
"$ref": "./examples/createOrUpdatePolicyDefinition.json"
},
"Create or update a policy definition with advanced parameters": {
"$ref": "./examples/createOrUpdatePolicyDefinitionAdvancedParams.json"
}
},
"parameters": [
{
"name": "policyDefinitionName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the policy definition to create."
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PolicyDefinition"
},
"description": "The policy definition properties."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"201": {
"description": "Created - Returns information about the policy definition.",
"schema": {
"$ref": "#/definitions/PolicyDefinition"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
},
"delete": {
"tags": [
"PolicyDefinitions"
],
"operationId": "PolicyDefinitions_Delete",
"summary": "Deletes a policy definition in a subscription.",
"description": "This operation deletes the policy definition in the given subscription with the given name.",
"x-ms-examples": {
"Delete a policy definition": {
"$ref": "./examples/deletePolicyDefinition.json"
}
},
"parameters": [
{
"name": "policyDefinitionName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the policy definition to delete."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"204": {
"description": "No Content"
},
"200": {
"description": "OK"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
},
"get": {
"tags": [
"PolicyDefinitions"
],
"operationId": "PolicyDefinitions_Get",
"summary": "Retrieves a policy definition in a subscription.",
"description": "This operation retrieves the policy definition in the given subscription with the given name.",
"x-ms-examples": {
"Retrieve a policy definition": {
"$ref": "./examples/getPolicyDefinition.json"
}
},
"parameters": [
{
"name": "policyDefinitionName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the policy definition to get."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns information about the policy definition.",
"schema": {
"$ref": "#/definitions/PolicyDefinition"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}": {
"get": {
"tags": [
"PolicyDefinitions"
],
"operationId": "PolicyDefinitions_GetBuiltIn",
"summary": "Retrieves a built-in policy definition.",
"description": "This operation retrieves the built-in policy definition with the given name.",
"x-ms-examples": {
"Retrieve a built-in policy definition": {
"$ref": "./examples/getBuiltinPolicyDefinition.json"
}
},
"parameters": [
{
"name": "policyDefinitionName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the built-in policy definition to get."
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns information about the built-in policy definition.",
"schema": {
"$ref": "#/definitions/PolicyDefinition"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}": {
"put": {
"tags": [
"PolicyDefinitions"
],
"operationId": "PolicyDefinitions_CreateOrUpdateAtManagementGroup",
"summary": "Creates or updates a policy definition in a management group.",
"description": "This operation creates or updates a policy definition in the given management group with the given name.",
"x-ms-examples": {
"Create or update a policy definition at management group level": {
"$ref": "./examples/createOrUpdatePolicyDefinitionAtManagementGroup.json"
}
},
"parameters": [
{
"name": "policyDefinitionName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the policy definition to create."
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PolicyDefinition"
},
"description": "The policy definition properties."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/ManagementGroupIdParameter"
}
],
"responses": {
"201": {
"description": "Created - Returns information about the policy definition.",
"schema": {
"$ref": "#/definitions/PolicyDefinition"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
},
"delete": {
"tags": [
"PolicyDefinitions"
],
"operationId": "PolicyDefinitions_DeleteAtManagementGroup",
"summary": "Deletes a policy definition in a management group.",
"description": "This operation deletes the policy definition in the given management group with the given name.",
"x-ms-examples": {
"Delete a policy definition at management group level": {
"$ref": "./examples/deletePolicyDefinitionAtManagementGroup.json"
}
},
"parameters": [
{
"name": "policyDefinitionName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the policy definition to delete."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/ManagementGroupIdParameter"
}
],
"responses": {
"204": {
"description": "No Content"
},
"200": {
"description": "OK"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
},
"get": {
"tags": [
"PolicyDefinitions"
],
"operationId": "PolicyDefinitions_GetAtManagementGroup",
"summary": "Retrieve a policy definition in a management group.",
"description": "This operation retrieves the policy definition in the given management group with the given name.",
"x-ms-examples": {
"Retrieve a policy definition at management group level": {
"$ref": "./examples/getPolicyDefinitionAtManagementGroup.json"
}
},
"parameters": [
{
"name": "policyDefinitionName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the policy definition to get."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/ManagementGroupIdParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns information about the policy definition.",
"schema": {
"$ref": "#/definitions/PolicyDefinition"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions": {
"get": {
"tags": [
"PolicyDefinitions"
],
"operationId": "PolicyDefinitions_List",
"summary": "Retrieves policy definitions in a subscription",
"description": "This operation retrieves a list of all the policy definitions in a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.",
"x-ms-examples": {
"List policy definitions by subscription": {
"$ref": "./examples/listPolicyDefinitions.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/PolicyDefinitionsFilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns an array of policy definitions.",
"schema": {
"$ref": "#/definitions/PolicyDefinitionListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Authorization/policyDefinitions": {
"get": {
"tags": [
"PolicyDefinitions"
],
"operationId": "PolicyDefinitions_ListBuiltIn",
"summary": "Retrieve built-in policy definitions",
"description": "This operation retrieves a list of all the built-in policy definitions that match the optional given $filter. If $filter='policyType -eq {value}' is provided, the returned list only includes all built-in policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy definitions whose category match the {value}.",
"x-ms-examples": {
"List built-in policy definitions": {
"$ref": "./examples/listBuiltInPolicyDefinitions.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/PolicyDefinitionsFilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns an array of built-in policy definitions.",
"schema": {
"$ref": "#/definitions/PolicyDefinitionListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions": {
"get": {
"tags": [
"PolicyDefinitions"
],
"operationId": "PolicyDefinitions_ListByManagementGroup",
"summary": "Retrieve policy definitions in a management group",
"description": "This operation retrieves a list of all the policy definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.",
"x-ms-examples": {
"List policy definitions by management group": {
"$ref": "./examples/listPolicyDefinitionsByManagementGroup.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/ManagementGroupIdParameter"
},
{
"$ref": "#/parameters/PolicyDefinitionsFilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"responses": {
"200": {
"description": "OK - Returns an array of policy definitions.",
"schema": {
"$ref": "#/definitions/PolicyDefinitionListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
"CloudError": {
"x-ms-external": true,
"properties": {
"error": {
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse"
}
},
"description": "An error response from a policy operation."
},
"PolicyDefinitionProperties": {
"properties": {
"policyType": {
"type": "string",
"description": "The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.",
"enum": [
"NotSpecified",
"BuiltIn",
"Custom",
"Static"
],
"x-ms-enum": {
"name": "policyType",
"modelAsString": true
}
},
"mode": {
"type": "string",
"description": "The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.",
"default": "Indexed"
},
"displayName": {
"type": "string",
"description": "The display name of the policy definition."
},
"description": {
"type": "string",
"description": "The policy definition description."
},
"policyRule": {
"type": "object",
"description": "The policy rule."
},
"metadata": {
"type": "object",
"description": "The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs."
},
"parameters": {
"description": "The parameter definitions for parameters used in the policy rule. The keys are the parameter names.",
"$ref": "#/definitions/ParameterDefinitions"
}
},
"description": "The policy definition properties."
},
"ParameterDefinitionsValue": {
"properties": {
"type": {
"description": "The data type of the parameter.",
"type": "string",
"enum": [
"String",
"Array",
"Object",
"Boolean",
"Integer",
"Float",
"DateTime"
],
"x-ms-enum": {
"name": "parameterType",
"modelAsString": true
}
},
"allowedValues": {
"type": "array",
"items": {
"type": "object"
},
"description": "The allowed values for the parameter."
},
"defaultValue": {
"type": "object",
"description": "The default value for the parameter if no value is provided."
},
"metadata": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name for the parameter."
},
"description": {
"type": "string",
"description": "The description of the parameter."
},
"strongType": {
"type": "string",
"description": "Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from."
},
"assignPermissions": {
"type": "boolean",
"description": "Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope."
}
},
"additionalProperties": {
"type": "object"
},
"description": "General metadata for the parameter."
}
},
"description": "The definition of a parameter that can be provided to the policy."
},
"ParameterDefinitions": {
"description": "The parameter definitions for parameters used in the policy. The keys are the parameter names.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ParameterDefinitionsValue"
}
},
"PolicyDefinition": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/PolicyDefinitionProperties",
"description": "The policy definition properties."
},
"id": {
"readOnly": true,
"type": "string",
"description": "The ID of the policy definition."
},
"name": {
"readOnly": true,
"type": "string",
"description": "The name of the policy definition."
},
"type": {
"readOnly": true,
"type": "string",
"description": "The type of the resource (Microsoft.Authorization/policyDefinitions)."
}
},
"description": "The policy definition.",
"x-ms-azure-resource": true
},
"PolicyDefinitionListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/PolicyDefinition"
},
"description": "An array of policy definitions."
},
"nextLink": {
"type": "string",
"description": "The URL to use for getting the next set of results."
}
},
"description": "List of policy definitions."
}
},
"parameters": {
"SubscriptionIdParameter": {
"name": "subscriptionId",
"in": "path",
"required": true,
"type": "string",
"description": "The ID of the target subscription."
},
"ManagementGroupIdParameter": {
"name": "managementGroupId",
"in": "path",
"required": true,
"type": "string",
"description": "The ID of the management group.",
"x-ms-parameter-location": "method"
},
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
"required": true,
"type": "string",
"description": "The API version to use for the operation."
},
"PolicyDefinitionsFilterParameter": {
"name": "$filter",
"in": "query",
"required": false,
"type": "string",
"description": "The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.",
"x-ms-skip-url-encoding": true,
"x-ms-parameter-location": "method"
},
"TopParameter": {
"name": "$top",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 1000,
"description": "Maximum number of records to return. When the $top filter is not provided, it will return 500 records.",
"x-ms-parameter-location": "method"
}
}
}