Skip to content

Commit cb38c2a

Browse files
committed
Updating the spec definition to reflect all properties and adjusting example to match the definition
Deploy.ConfigurationItem response now also includes deployStatus field Change example to accurately present available fields
1 parent 63eae81 commit cb38c2a

1 file changed

Lines changed: 55 additions & 15 deletions

File tree

specs/SHIELD.json

Lines changed: 55 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1113,7 +1113,7 @@
11131113
},
11141114
"Deploy.ConfigurationItem": {
11151115
"title": "Deploy - Configuration Item List",
1116-
"description": "",
1116+
"description": "Collection of objects representing the configuration items with curated properties and values in user-friendly format.",
11171117
"type": "array",
11181118
"items": {
11191119
"description": "",
@@ -1140,6 +1140,19 @@
11401140
]
11411141
]
11421142
},
1143+
"deployState": {
1144+
"type": "string",
1145+
"description": "Indicator of the infrastructure configuration item's current state. Mutated means that the item has been modified by the end user outside of SHIELD.",
1146+
"enum": [
1147+
"notDeployed",
1148+
"deployed",
1149+
"Mutated",
1150+
"error"
1151+
],
1152+
"examples": [
1153+
"deployed"
1154+
]
1155+
},
11431156
"groupTagList": {
11441157
"type": "array",
11451158
"description": "List of metadata tags that indicate which deployment sets the configuration item is compatible with.",
@@ -1253,6 +1266,7 @@
12531266
},
12541267
"required": [
12551268
"childDependencies",
1269+
"deployState",
12561270
"groupTagList",
12571271
"msCloudTypes",
12581272
"parentDependencies",
@@ -1265,6 +1279,7 @@
12651279
"7e1a2b3c-4d5f-4a8b-9e6a-1c2b7f3d8e4a",
12661280
"9c2e7a1b-5d3f-4a8b-2c6e-7f1a3d9e8b5c"
12671281
],
1282+
"deployState": "deployed",
12681283
"groupTagList": [
12691284
{
12701285
"description": "Collection of policies covering critical conditional access settings.",
@@ -1290,6 +1305,7 @@
12901305
"7e1a2b3c-4d5f-4a8b-9e6a-1c2b7f3d8e4a",
12911306
"9c2e7a1b-5d3f-4a8b-2c6e-7f1a3d9e8b5c"
12921307
],
1308+
"deployState": "deployed",
12931309
"groupTagList": [
12941310
{
12951311
"description": "Collection of policies covering critical conditional access settings.",
@@ -1310,6 +1326,7 @@
13101326
"childDependencies": [
13111327
"1c2b5d3f-7a1b-4a8b-9e6a-2e4a3b7e8c5d"
13121328
],
1329+
"deployState": "notDeployed",
13131330
"groupTagList": [
13141331
{
13151332
"description": "Principal containers that are used to provide assignments.",
@@ -3655,22 +3672,45 @@
36553672
"summary": "Available Configuration Items",
36563673
"value": [
36573674
{
3658-
"id": "5e2a9c1f-8b3d-4f6a-9e7c-2d1f3a6b4c8e",
3659-
"name": "Core Security Group",
3660-
"description": "A core security group that contains essential security roles and permissions.",
3661-
"type": "SecurityGroup",
3662-
"isActive": true,
3663-
"createdAt": "2024-02-20T10:00:00Z",
3664-
"updatedAt": "2024-05-15T11:30:00Z"
3675+
"childDependencies": [
3676+
"7e1a2b3c-4d5f-4a8b-9e6a-1c2b7f3d8e4a",
3677+
"9c2e7a1b-5d3f-4a8b-2c6e-7f1a3d9e8b5c"
3678+
],
3679+
"deployState": "deployed",
3680+
"groupTagList": [
3681+
{
3682+
"description": "Collection of policies covering critical conditional access settings.",
3683+
"displayName": "Conditional Policy",
3684+
"tagId": "3b7e2a1c-4d5f-4a8b-9e6a-2c1b7f3d8e4a"
3685+
}
3686+
],
3687+
"msCloudTypes": [
3688+
"Public"
3689+
],
3690+
"parentDependencies": [
3691+
"8e6a1c2b-7f3d-4a8b-9c2e-5d3f7a1b2e4a"
3692+
],
3693+
"templateId": "2a1c7e3b-5d4f-4a8b-9e6a-7f3d2b1c8e4a",
3694+
"urlPath": "/identity/conditionalAccess/policies"
36653695
},
36663696
{
3667-
"id": "9c7f2e1a-3b6d-4a8e-9f5c-1d2a4b7e6c3f",
3668-
"name": "Scope Tag - Confidential Data",
3669-
"description": "A scope tag designed to restrict access to confidential data resources.",
3670-
"type": "ScopeTag",
3671-
"isActive": true,
3672-
"createdAt": "2024-04-12T14:20:00Z",
3673-
"updatedAt": "2024-07-01T09:50:00Z"
3697+
"childDependencies": [
3698+
"1c2b5d3f-7a1b-4a8b-9e6a-2e4a3b7e8c5d"
3699+
],
3700+
"deployState": "notDeployed",
3701+
"groupTagList": [
3702+
{
3703+
"description": "Principal containers that are used to provide assignments.",
3704+
"displayName": "Administrative Unit",
3705+
"tagId": "5d3f9c2e-7a1b-4a8b-2c6e-1a3d7e8b5c4a"
3706+
}
3707+
],
3708+
"msCloudTypes": [
3709+
"Public"
3710+
],
3711+
"parentDependencies": [],
3712+
"templateId": "4a8b7e1a-2b3c-4d5f-9e6a-1c2b7f3d8e4a",
3713+
"urlPath": "/directory/administrativeUnits"
36743714
}
36753715
]
36763716
}

0 commit comments

Comments
 (0)