Skip to content

Commit 5b07a79

Browse files
eatkimcheerflmk
eatkimchee
and
rflmk
authored
[Hub Generated] Publish private branch 'eatkimchee-fist-Microsoft.IoTFirmwareDefense-2023-02-08-preview' (#23921)
* add or modify files * Fix validation errors - remove references to old private preview versions from readme.md - add binary hardening flags to custom-words.txt * make changes from review comments - remove unused param - rename definition to match usage - make sas token response properties more clear with description and format and readOnly - move domain-specific terms to cSpell.json * fix urls in examples * remove x-nullable from string url properties --------- Co-authored-by: rflmk <[email protected]>
1 parent c2c2f7a commit 5b07a79

File tree

62 files changed

+4538
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+4538
-0
lines changed

‎cSpell.json‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -917,6 +917,15 @@
917917
"Transliterable",
918918
"translitered"
919919
]
920+
},
921+
{
922+
"filename": "**/specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/preview/**/*.json",
923+
"words": [
924+
"RELRO",
925+
"relro",
926+
"rpath",
927+
"runpath"
928+
]
920929
}
921930
],
922931
"enableFiletypes": [

‎specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/preview/2023-02-08-preview/common.json‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"version": "2023-02-08-preview",
5+
"title": "fist",
6+
"description": "The definitions and parameters in this swagger specification will be used to manage the IoT Firmware Defense resources."
7+
},
8+
"host": "management.azure.com",
9+
"schemes": [
10+
"https"
11+
],
12+
"consumes": [
13+
"application/json"
14+
],
15+
"produces": [
16+
"application/json"
17+
],
18+
"security": [
19+
{
20+
"azure_auth": [
21+
"user_impersonation"
22+
]
23+
}
24+
],
25+
"securityDefinitions": {
26+
"azure_auth": {
27+
"type": "oauth2",
28+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
29+
"flow": "implicit",
30+
"description": "Azure Active Directory OAuth2 Flow.",
31+
"scopes": {
32+
"user_impersonation": "impersonate your user account"
33+
}
34+
}
35+
},
36+
"paths": {},
37+
"definitions": {
38+
"UrlToken": {
39+
"type": "object",
40+
"properties": {
41+
"url": {
42+
"description": "SAS URL for creating or accessing a blob file.",
43+
"type": "string",
44+
"format": "uri",
45+
"readOnly": true
46+
},
47+
"uploadUrl": {
48+
"description": "SAS URL for file uploading. Kept for backwards compatibility",
49+
"type": "string",
50+
"format": "uri",
51+
"readOnly": true
52+
}
53+
},
54+
"description": "Url data for creating or accessing a blob file."
55+
},
56+
"Firmware": {
57+
"type": "object",
58+
"description": "Firmware definition",
59+
"properties": {
60+
"properties": {
61+
"title": "Firmware properties",
62+
"description": "The properties of a firmware",
63+
"x-ms-client-flatten": true,
64+
"$ref": "#/definitions/FirmwareProperties"
65+
}
66+
},
67+
"allOf": [
68+
{
69+
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
70+
}
71+
]
72+
},
73+
"FirmwareUpdateDefinition": {
74+
"type": "object",
75+
"description": "Firmware definition",
76+
"properties": {
77+
"properties": {
78+
"title": "Firmware properties",
79+
"description": "The editable properties of a firmware",
80+
"x-ms-client-flatten": true,
81+
"$ref": "#/definitions/FirmwareProperties"
82+
}
83+
}
84+
},
85+
"FirmwareProperties": {
86+
"type": "object",
87+
"properties": {
88+
"fileName": {
89+
"type": "string",
90+
"description": "File name for a firmware that user uploaded."
91+
},
92+
"vendor": {
93+
"type": "string",
94+
"description": "Firmware vendor."
95+
},
96+
"model": {
97+
"type": "string",
98+
"description": "Firmware model."
99+
},
100+
"version": {
101+
"type": "string",
102+
"description": "Firmware version."
103+
},
104+
"description": {
105+
"type": "string",
106+
"description": "User-specified description of the firmware."
107+
},
108+
"fileSize": {
109+
"description": "File size of the uploaded firmware image.",
110+
"type": "integer",
111+
"format": "int64",
112+
"x-nullable": true
113+
},
114+
"status": {
115+
"type": "string",
116+
"description": "The status of firmware scan.",
117+
"enum": [
118+
"Pending",
119+
"Extracting",
120+
"Analyzing",
121+
"Ready",
122+
"Error"
123+
],
124+
"default": "Pending",
125+
"x-ms-enum": {
126+
"name": "status",
127+
"modelAsString": true
128+
}
129+
},
130+
"statusMessages": {
131+
"type": "array",
132+
"description": "A list of errors or other messages generated during firmware analysis",
133+
"items": {
134+
"$ref": "#/definitions/StatusMessage"
135+
},
136+
"x-ms-identifiers": []
137+
},
138+
"provisioningState": {
139+
"description": "Provisioning state of the resource.",
140+
"type": "string",
141+
"enum": [
142+
"Accepted",
143+
"Succeeded",
144+
"Canceled",
145+
"Failed"
146+
],
147+
"x-ms-enum": {
148+
"name": "ProvisioningState",
149+
"modelAsString": true
150+
},
151+
"readOnly": true
152+
}
153+
},
154+
"description": "Firmware properties."
155+
},
156+
"StatusMessage": {
157+
"type": "object",
158+
"description": "Error and status message"
159+
}
160+
},
161+
"parameters": {
162+
"FirmwareIdParameter": {
163+
"name": "firmwareId",
164+
"in": "path",
165+
"required": true,
166+
"type": "string",
167+
"description": "The id of the firmware.",
168+
"x-ms-parameter-location": "method"
169+
},
170+
"WorkspaceNameParameter": {
171+
"name": "workspaceName",
172+
"in": "path",
173+
"required": true,
174+
"type": "string",
175+
"description": "The name of the firmware analysis workspace.",
176+
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
177+
"x-ms-parameter-location": "method"
178+
}
179+
}
180+
}

‎specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/preview/2023-02-08-preview/examples/Firmware_Create_MaximumSet_Gen.json‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
{
2+
"title": "Firmware_Create",
3+
"operationId": "Firmware_Create",
4+
"parameters": {
5+
"subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE",
6+
"resourceGroupName": "rgworkspaces-firmwares",
7+
"workspaceName": "A7",
8+
"firmwareId": "umrkdttp",
9+
"api-version": "2023-02-08-preview",
10+
"firmware": {
11+
"properties": {
12+
"fileName": "wresexxulcdsdd",
13+
"vendor": "vycmdhgtmepcptyoubztiuudpkcpd",
14+
"model": "f",
15+
"version": "s",
16+
"description": "uz",
17+
"fileSize": 17,
18+
"status": "Pending",
19+
"statusMessages": [
20+
{
21+
"message": "ulvhmhokezathzzauiitu"
22+
}
23+
]
24+
}
25+
}
26+
},
27+
"responses": {
28+
"200": {
29+
"body": {
30+
"properties": {
31+
"fileName": "wresexxulcdsdd",
32+
"vendor": "vycmdhgtmepcptyoubztiuudpkcpd",
33+
"model": "f",
34+
"version": "s",
35+
"description": "uz",
36+
"fileSize": 17,
37+
"status": "Pending",
38+
"statusMessages": [
39+
{
40+
"message": "ulvhmhokezathzzauiitu"
41+
}
42+
],
43+
"provisioningState": "Accepted"
44+
},
45+
"id": "koexkheccwpzwqob",
46+
"name": "brmvnojpmxsgckdviynhxhftvcvbw",
47+
"type": "vlxhdbrphhnttmxvawwwewza",
48+
"systemData": {
49+
"createdBy": "aylilpicryidesowemwnl",
50+
"createdByType": "User",
51+
"createdAt": "2023-02-19T06:40:29.228Z",
52+
"lastModifiedBy": "bgtifu",
53+
"lastModifiedByType": "User",
54+
"lastModifiedAt": "2023-02-19T06:40:29.228Z"
55+
}
56+
}
57+
},
58+
"201": {
59+
"body": {
60+
"properties": {
61+
"fileName": "wresexxulcdsdd",
62+
"vendor": "vycmdhgtmepcptyoubztiuudpkcpd",
63+
"model": "f",
64+
"version": "s",
65+
"description": "uz",
66+
"fileSize": 17,
67+
"status": "Pending",
68+
"statusMessages": [
69+
{
70+
"message": "ulvhmhokezathzzauiitu"
71+
}
72+
],
73+
"provisioningState": "Accepted"
74+
},
75+
"id": "koexkheccwpzwqob",
76+
"name": "brmvnojpmxsgckdviynhxhftvcvbw",
77+
"type": "vlxhdbrphhnttmxvawwwewza",
78+
"systemData": {
79+
"createdBy": "aylilpicryidesowemwnl",
80+
"createdByType": "User",
81+
"createdAt": "2023-02-19T06:40:29.228Z",
82+
"lastModifiedBy": "bgtifu",
83+
"lastModifiedByType": "User",
84+
"lastModifiedAt": "2023-02-19T06:40:29.228Z"
85+
}
86+
}
87+
}
88+
}
89+
}

‎specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/preview/2023-02-08-preview/examples/Firmware_Create_MinimumSet_Gen.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"title": "Firmware_Create",
3+
"operationId": "Firmware_Create",
4+
"parameters": {
5+
"subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE",
6+
"resourceGroupName": "rgworkspaces-firmwares",
7+
"workspaceName": "A7",
8+
"firmwareId": "umrkdttp",
9+
"api-version": "2023-02-08-preview",
10+
"firmware": {}
11+
},
12+
"responses": {
13+
"200": {
14+
"body": {}
15+
},
16+
"201": {
17+
"body": {}
18+
}
19+
}
20+
}

‎specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/preview/2023-02-08-preview/examples/Firmware_Delete_MaximumSet_Gen.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"title": "Firmware_Delete",
3+
"operationId": "Firmware_Delete",
4+
"parameters": {
5+
"subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE",
6+
"resourceGroupName": "rgworkspaces-firmwares",
7+
"workspaceName": "A7",
8+
"firmwareId": "umrkdttp",
9+
"api-version": "2023-02-08-preview"
10+
},
11+
"responses": {
12+
"200": {},
13+
"204": {}
14+
}
15+
}

‎specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/preview/2023-02-08-preview/examples/Firmware_Delete_MinimumSet_Gen.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"title": "Firmware_Delete",
3+
"operationId": "Firmware_Delete",
4+
"parameters": {
5+
"subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE",
6+
"resourceGroupName": "rgworkspaces-firmwares",
7+
"workspaceName": "A7",
8+
"firmwareId": "umrkdttp",
9+
"api-version": "2023-02-08-preview"
10+
},
11+
"responses": {
12+
"200": {},
13+
"204": {}
14+
}
15+
}

‎specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/preview/2023-02-08-preview/examples/Firmware_GenerateBinaryHardeningDetails_MaximumSet_Gen.json‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"title": "Firmware_GenerateBinaryHardeningDetails",
3+
"operationId": "Firmware_GenerateBinaryHardeningDetails",
4+
"parameters": {
5+
"subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE",
6+
"resourceGroupName": "rgworkspaces-firmwares",
7+
"workspaceName": "A7",
8+
"firmwareId": "umrkdttp",
9+
"api-version": "2023-02-08-preview"
10+
},
11+
"responses": {
12+
"200": {
13+
"body": {
14+
"binaryHardeningId": "paobczlmlkfeozykeeq",
15+
"features": {
16+
"nx": "True",
17+
"pie": "True",
18+
"relro": "True",
19+
"canary": "True",
20+
"stripped": "True"
21+
},
22+
"architecture": "rfqnzhnwitn",
23+
"path": "ewqypeaihlnqdeesblp",
24+
"class": "szvunaemnqnwqmfdx",
25+
"runpath": "aecstzybleqdwwhavfcywyo",
26+
"rpath": "jigblxjxxqiskihigkmpqgrygxxx"
27+
}
28+
}
29+
}
30+
}

‎specification/fist/resource-manager/Microsoft.IoTFirmwareDefense/preview/2023-02-08-preview/examples/Firmware_GenerateBinaryHardeningDetails_MinimumSet_Gen.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"title": "Firmware_GenerateBinaryHardeningDetails",
3+
"operationId": "Firmware_GenerateBinaryHardeningDetails",
4+
"parameters": {
5+
"subscriptionId": "685C0C6F-9867-4B1C-A534-AA3A05B54BCE",
6+
"resourceGroupName": "rgworkspaces-firmwares",
7+
"workspaceName": "A7",
8+
"firmwareId": "umrkdttp",
9+
"api-version": "2023-02-08-preview"
10+
},
11+
"responses": {
12+
"200": {
13+
"body": {}
14+
}
15+
}
16+
}

0 commit comments

Comments
 (0)