Skip to content
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "Create or update export",
"description": "Create a new export or update an existing export, specifying its Id.",
"title": "Create or replace export",
"description": "Create a new export or replace an existing export, specifying its Id.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"title": "Update export",
"description": "Update parts of an existing continuous data export, specifying its Id.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"export_id": "abc",
"body": {
"displayName": "Updated export name",
"endpoint": {
"type": "StorageEndpoint",
"connectionString": "<updated connection string>",
"name": "Blob 1"
},
"enabled": false,
"sources": [
"devices",
"deviceTemplates",
"telemetry"
]
}
},
"responses": {
"200": {
"body": {
"id": "abc",
"etag": "493aface-4c5e-4318-89e9-f6586f687009",
"displayName": "Updated export name",
"endpoint": {
"type": "StorageEndpoint",
"connectionString": "<updated connection string",
"name": "Blob 1"
},
"status": "stopped",
"enabled": false,
"sources": [
"devices",
"deviceTemplates",
"telemetry"
]
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"title": "Replace cloud properties of a device",
"description": "Replace cloud properties of a device.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"body": {
"AssetID": "123abc"
},
"device_id": "mx1"
},
"responses": {
"200": {
"body": {
"AssetID": "123abc"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
{
"title": "Update cloud properties of a device",
"description": "Update cloud properties of a device.",
"description": "Update some or all cloud properties of a device.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"body": {
"AssetID": "123abc"
"AssetID": "updated value"
},
"device_id": "mx1"
},
"responses": {
"200": {
"body": {
"AssetID": "123abc"
"AssetID": "updated value"
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,24 @@
"component_name": "Thermostat_1o",
"command_name": "CoolDown",
"body": {
"connectionTimeout": 10,
"responseTimeout": 10,
"request": {
"tempVal": 30
}
}
},
"responses": {
"201": {
"body": {}
"body": {
"request": {
"tempVal": 30
},
"connectionTimeout": 10,
"responseTimeout": 10,
"response": "Sample response value",
"responseCode": 200
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"title": "Update device properties in component",
"description": "Update some or all of the read-write property values within a component of a device.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"device_id": "mx1",
"component_name": "settings",
"body": {
"fanSpeed": 101,
"irSwitch": true
}
},
"responses": {
"202": {
"body": {
"$metadata": {
"fanSpeed": {
"desiredValue": 101
},
"irSwitch": {
"desiredValue": true
}
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"title": "Set device properties",
"description": "Replace the values of read-write device properties of a device",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"device_id": "mx1",
"body": {
"settings": {
"voltage": 25,
"current": 7
}
}
},
"responses": {
"202": {
"body": {
"settings": {
"$metadata": {
"voltage": {
"desiredValue": 25
},
"current": {
"desiredValue": 7
}
}
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "Update device properties",
"description": "Update the values of read-write properties of a device",
"description": "Update some or all values of read-write device properties of a device",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "Create a device",
"description": "Create a device with an Id.",
"title": "Create or replace a device",
"description": "Create or replace device with an Id.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"title": "Update a device",
"description": "Update parts of an existing device with an Id.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"device_id": "ccc",
"body": {
"displayName": "Updated displayName",
"instanceOf": "urn:baacbx8bk:modelDefinition:lgxugnniks",
"approved": false
}
},
"responses": {
"200": {
"body": {
"id": "ccc",
"etag": "eyJoZWFkZXIiOiJcIjAxMDAyNmVjLTAwMDAtMGQwMC0wMDAwLTVkYmZkMjFhMDAwMFwiIn0",
"displayName": "Updated displayName",
"instanceOf": "urn:baacbx8bk:modelDefinition:lgxugnniks",
"simulated": false,
"provisioned": true,
"approved": false
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "Update properties of a module within a component",
"description": "Update the values of read-write properties of a module within a single component",
"title": "Set properties of a module within a component",
"description": "Replace all values of read-write properties of a module within a single component",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"title": "Update properties of a module within a component",
"description": "Update some or all values of read-write properties of a module within a single component",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"device_id": "mx1",
"module_name": "module_env",
"component_name": "componentA",
"body": {
"SensitivityDial": 300
}
},
"responses": {
"202": {
"body": {
"SensitivityDial": 50,
"$metadata": {
"SensitivityDial": {
"desiredValue": 300,
"desiredVersion": 3,
"ackVersion": 1,
"ackDescription": "Ok",
"ackCode": 200,
"lastUpdateTime": "2020-04-27T22:08:55.1149957Z"
}
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"title": "Set all properties of a module",
"description": "Set the values of all read-write properties of a module",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"device_id": "mx1",
"module_name": "module_env",
"body": {
"componentA": {
"SensitivityDial": 200
}
}
},
"responses": {
"202": {
"body": {
"componentA": {
"SensitivityDial": 75,
"$metadata": {
"SensitivityDial": {
"desiredValue": 200,
"desiredVersion": 3,
"ackVersion": 1,
"ackDescription": "Ok",
"ackCode": 200,
"lastUpdateTime": "2020-04-27T22:08:55.1149957Z"
}
}
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "Update properties of a module",
"description": "Update the values of read-write properties of a module",
"title": "Update device properties of a module",
"description": "Update some or all values read-write properties of a module",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"type": "EmailUser",
"roles": [
{
"role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
"role": "<role Id>"
}
],
"email": "[email protected]"
Expand All @@ -21,7 +21,7 @@
"type": "EmailUser",
"roles": [
{
"role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
"role": "<role Id>"
}
],
"email": "[email protected]"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"title": "Add or update a service principal in your application",
"description": "Add or update an AAD service principal in your application.",
"title": "Add or replace a service principal in your application",
"description": "Add or replace an AAD service principal in your application.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"user_id": "123",
"body": {
"type": "ServicePrincipalUser",
"tenantId": "027fdad7-cf0f-470a-a26a-272197813322",
"objectId": "65e13aac-1443-4c49-9d49-57b87197cfff",
"tenantId": "<tenant Id>",
"objectId": "<object Id>",
"roles": [
{
"role": "c7be2c6b-797e-4551-bb24-33709f6b2e20"
"role": "<role Id>"
}
]
}
Expand All @@ -21,11 +21,11 @@
"body": {
"id": "123",
"type": "ServicePrincipalUser",
"tenantId": "027fdad7-cf0f-470a-a26a-272197813322",
"objectId": "65e13aac-1443-4c49-9d49-57b87197cfff",
"tenantId": "<tenant Id>",
"objectId": "<object Id>",
"roles": [
{
"role": "c7be2c6b-797e-4551-bb24-33709f6b2e20"
"role": "<role Id>"
}
]
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"title": "Update a user in your application",
"description": "Update a user in your application.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"user_id": "123",
"body": {
"roles": [
{
"role": "<new role Id>"
}
]
}
},
"responses": {
"200": {
"body": {
"type": "EmailUser",
"roles": [
{
"role": "<new role Id>"
}
],
"email": "[email protected]"
}
}
}
}
Loading