Skip to content

Commit 9936295

Browse files
authored
Download files for cm sensors (#11635)
* Added API of DownloadQuotaData to iotDefenderSettings and DownloadResetPassword to iotSensors * Added reset password api also for the on premise iot sensors * renamed DownloadQuotaData to DownloadManagerActivation * Fixed the body in the DownloadResetPassword API
1 parent d0a2935 commit 9936295

File tree

6 files changed

+216
-0
lines changed

6 files changed

+216
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"parameters": {
3+
"api-version": "2020-08-06-preview",
4+
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23"
5+
},
6+
"responses": {
7+
"200": {
8+
"headers": {
9+
"content-type": "application/zip"
10+
},
11+
"body": "{Binary}"
12+
}
13+
}
14+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"parameters": {
3+
"api-version": "2020-08-06-preview",
4+
"scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub",
5+
"iotSensorName": "mySensor",
6+
"body": {
7+
"applianceId": "3214-528AV23-D121-D3-E1"
8+
}
9+
},
10+
"responses": {
11+
"200": {
12+
"headers": {
13+
"content-type": "application/zip"
14+
},
15+
"body": "{Binary}"
16+
}
17+
}
18+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"parameters": {
3+
"api-version": "2020-08-06-preview",
4+
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
5+
"onPremiseIotSensorName": "mySensor",
6+
"body": {
7+
"applianceId": "3214-528AV23-D121-D3-E1"
8+
}
9+
},
10+
"responses": {
11+
"200": {
12+
"headers": {
13+
"content-type": "application/zip"
14+
},
15+
"body": "{Binary}"
16+
}
17+
}
18+
}

specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,46 @@
218218
}
219219
}
220220
}
221+
},
222+
"/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default/downloadManagerActivation": {
223+
"post": {
224+
"x-ms-examples": {
225+
"Download quota data of the subscription": {
226+
"$ref": "./examples/IotDefenderSettings/DownloadManagerActivation.json"
227+
}
228+
},
229+
"tags": [
230+
"IoT Defender Settings"
231+
],
232+
"operationId": "IotDefenderSettings_DownloadManagerActivation",
233+
"description": "Download manager activation data defined for this subscription",
234+
"parameters": [
235+
{
236+
"$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
237+
},
238+
{
239+
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
240+
}
241+
],
242+
"produces": [
243+
"application/zip"
244+
],
245+
"responses": {
246+
"200": {
247+
"description": "Downloaded file",
248+
"schema": {
249+
"type": "object",
250+
"format": "file"
251+
}
252+
},
253+
"default": {
254+
"description": "Error response describing why the operation failed.",
255+
"schema": {
256+
"$ref": "../../../common/v1/types.json#/definitions/CloudError"
257+
}
258+
}
259+
}
260+
}
221261
}
222262
},
223263
"definitions": {

specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSensors.json

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,59 @@
231231
}
232232
}
233233
}
234+
},
235+
"/{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}/downloadResetPassword": {
236+
"post": {
237+
"x-ms-examples": {
238+
"Download file for reset password of the sensor": {
239+
"$ref": "./examples/IotSensors/DownloadResetPassword.json"
240+
}
241+
},
242+
"tags": [
243+
"IoT Sensors"
244+
],
245+
"operationId": "IotSensors_DownloadResetPassword",
246+
"description": "Download file for reset password of the sensor",
247+
"produces": [
248+
"application/zip"
249+
],
250+
"parameters": [
251+
{
252+
"$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
253+
},
254+
{
255+
"$ref": "#/parameters/IotSensorScope"
256+
},
257+
{
258+
"$ref": "#/parameters/IotSensorName"
259+
},
260+
{
261+
"in": "body",
262+
"name": "body",
263+
"required": true,
264+
"description": "The reset password input.",
265+
"schema": {
266+
"$ref": "#/definitions/ResetPasswordInput"
267+
},
268+
"x-ms-parameter-location": "method"
269+
}
270+
],
271+
"responses": {
272+
"200": {
273+
"description": "Downloaded reset password file",
274+
"schema": {
275+
"type": "object",
276+
"format": "file"
277+
}
278+
},
279+
"default": {
280+
"description": "Error response describing why the operation failed.",
281+
"schema": {
282+
"$ref": "../../../common/v1/types.json#/definitions/CloudError"
283+
}
284+
}
285+
}
286+
}
234287
}
235288
},
236289
"definitions": {
@@ -268,6 +321,16 @@
268321
"type": "object",
269322
"description": "IoT sensor properties",
270323
"properties": {}
324+
},
325+
"ResetPasswordInput": {
326+
"type": "object",
327+
"description": "Reset password input.",
328+
"properties": {
329+
"applianceId": {
330+
"description": "The appliance id of the sensor.",
331+
"type": "string"
332+
}
333+
}
271334
}
272335
},
273336
"parameters": {

specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,59 @@
231231
}
232232
}
233233
}
234+
},
235+
"/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors/{onPremiseIotSensorName}/downloadResetPassword": {
236+
"post": {
237+
"x-ms-examples": {
238+
"Download file for reset password of the sensor": {
239+
"$ref": "./examples/OnPremiseIotSensors/DownloadResetPassword.json"
240+
}
241+
},
242+
"tags": [
243+
"IoT Sensors"
244+
],
245+
"operationId": "OnPremiseIotSensors_DownloadResetPassword",
246+
"description": "Download file for reset password of the sensor",
247+
"produces": [
248+
"application/zip"
249+
],
250+
"parameters": [
251+
{
252+
"$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
253+
},
254+
{
255+
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
256+
},
257+
{
258+
"$ref": "#/parameters/OnPremiseIotSensorName"
259+
},
260+
{
261+
"in": "body",
262+
"name": "body",
263+
"required": true,
264+
"description": "Input for reset password.",
265+
"schema": {
266+
"$ref": "#/definitions/ResetPasswordInput"
267+
},
268+
"x-ms-parameter-location": "method"
269+
}
270+
],
271+
"responses": {
272+
"200": {
273+
"description": "Downloaded reset password file",
274+
"schema": {
275+
"type": "object",
276+
"format": "file"
277+
}
278+
},
279+
"default": {
280+
"description": "Error response describing why the operation failed.",
281+
"schema": {
282+
"$ref": "../../../common/v1/types.json#/definitions/CloudError"
283+
}
284+
}
285+
}
286+
}
234287
}
235288
},
236289
"definitions": {
@@ -268,6 +321,16 @@
268321
"type": "object",
269322
"description": "On-premise IoT sensor properties",
270323
"properties": {}
324+
},
325+
"ResetPasswordInput": {
326+
"description": "Reset password input.",
327+
"type": "object",
328+
"properties": {
329+
"applianceId": {
330+
"description": "The appliance id of the sensor.",
331+
"type": "string"
332+
}
333+
}
271334
}
272335
},
273336
"parameters": {

0 commit comments

Comments
 (0)