{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Devices API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Devices", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Get Sensor Partners Sensorpartnerid Devices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sensor-partners/:sensorPartnerId/devices", "params": [ { "name": "parentDeviceIds", "value": "", "type": "query", "description": "Id's of the parent devices." }, { "name": "deviceDataModelIds", "value": "", "type": "query", "description": "Id's of the device data models." }, { "name": "sensorPartnerId", "value": "", "type": "path", "description": "Id of the associated sensor partner." }, { "name": "ids", "value": "", "type": "query", "description": "Ids of the resource." }, { "name": "names", "value": "", "type": "query", "description": "Names of the resource." }, { "name": "propertyFilters", "value": "", "type": "query", "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\"." }, { "name": "statuses", "value": "", "type": "query", "description": "Statuses of the resource." }, { "name": "minCreatedDateTime", "value": "", "type": "query", "description": "Minimum creation date of resource (inclusive)." }, { "name": "maxCreatedDateTime", "value": "", "type": "query", "description": "Maximum creation date of resource (inclusive)." }, { "name": "minLastModifiedDateTime", "value": "", "type": "query", "description": "Minimum last modified date of resource (inclusive)." }, { "name": "maxLastModifiedDateTime", "value": "", "type": "query", "description": "Maximum last modified date of resource (inclusive)." }, { "name": "maxPageSize", "value": "", "type": "query", "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50." }, { "name": "skipToken", "value": "", "type": "query", "description": "Skip token for getting next set of results." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version" } ] }, "docs": "Returns a paginated list of device resources." }, { "info": { "name": "Microsoft Azure Get Sensor Partners Sensorpartnerid Devices Deviceid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sensor-partners/:sensorPartnerId/devices/:deviceId", "params": [ { "name": "sensorPartnerId", "value": "", "type": "path", "description": "Id of the sensor partner." }, { "name": "deviceId", "value": "", "type": "path", "description": "Id of the device resource." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version" } ] }, "docs": "Gets a device entity." }, { "info": { "name": "Microsoft Azure Patch Sensor Partners Sensorpartnerid Devices Deviceid", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/sensor-partners/:sensorPartnerId/devices/:deviceId", "params": [ { "name": "sensorPartnerId", "value": "", "type": "path", "description": "Id of the sensor partner." }, { "name": "deviceId", "value": "", "type": "path", "description": "Id of the device resource." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version" } ] }, "docs": "Create a device entity." }, { "info": { "name": "Microsoft Azure Delete Sensor Partners Sensorpartnerid Devices Deviceid", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/sensor-partners/:sensorPartnerId/devices/:deviceId", "params": [ { "name": "sensorPartnerId", "value": "", "type": "path", "description": "Id of the sensor partner." }, { "name": "deviceId", "value": "", "type": "path", "description": "Id of the device resource." }, { "name": "api-version", "value": "", "type": "query", "description": "The requested API version" } ] }, "docs": "Deletes a device entity." }, { "info": { "name": "Microsoft Azure Get The List Of Devices In An Application With Basic Odata Support Maxpagesize, Filter, Orderby , [more Details] Https: Aka Ms Iotcentralodatasupport", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "filter", "value": "", "type": "query", "description": "An expression on the resource type that selects the resources to be returned." }, { "name": "maxpagesize", "value": "", "type": "query", "description": "The maximum number of resources to return from one response." }, { "name": "orderby", "value": "", "type": "query", "description": "An expression that specify the order of the returned resources." }, { "name": "expand", "value": "", "type": "query", "description": "The query parameter for including requested entities in response." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get A Device By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "expand", "value": "", "type": "query", "description": "The query parameter for including requested entities in response." } ] }, "docs": "Get details about an existing device by device ID." }, { "info": { "name": "Microsoft Azure Create Or Update A Device", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/devices/:deviceId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "expand", "value": "", "type": "query", "description": "The query parameter for including requested entities in response." } ] }, "docs": "Create a new device." }, { "info": { "name": "Microsoft Azure Update A Device Via Patch", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/devices/:deviceId", "headers": [ { "name": "If-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "expand", "value": "", "type": "query", "description": "The query parameter for including requested entities in response." } ] }, "docs": "Update an existing device by ID." }, { "info": { "name": "Microsoft Azure Delete A Device", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/devices/:deviceId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "expand", "value": "", "type": "query", "description": "The query parameter for including requested entities in response." } ] }, "docs": "Delete an existing device by device ID." }, { "info": { "name": "Microsoft Azure Apply A Deployment Manifest To An Edge Device", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/devices/:deviceId/applyDeploymentManifest", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." } ] }, "docs": "Apply a deployment manifest to an edge device." }, { "info": { "name": "Microsoft Azure Get Device Attestation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/attestation", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Create An Individual Device Attestation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/devices/:deviceId/attestation", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Update An Individual Device Attestation Via Patch", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/devices/:deviceId/attestation", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Remove An Individual Device Attestation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/devices/:deviceId/attestation", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get Device Command History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/commands/:commandName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "commandName", "value": "", "type": "path", "description": "Name of this device command." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Run A Device Command", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/devices/:deviceId/commands/:commandName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "commandName", "value": "", "type": "path", "description": "Name of this device command." } ] }, "docs": "Run a command on a device." }, { "info": { "name": "Microsoft Azure List The Components Present In A Device", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/components", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get Component Command History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/components/:componentName/commands/:commandName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "componentName", "value": "", "type": "path", "description": "Name of the device component." }, { "name": "commandName", "value": "", "type": "path", "description": "Name of this device command." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Run A Component Command", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/devices/:deviceId/components/:componentName/commands/:commandName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "componentName", "value": "", "type": "path", "description": "Name of the device component." }, { "name": "commandName", "value": "", "type": "path", "description": "Name of this device command." } ] }, "docs": "Run a command on a component." }, { "info": { "name": "Microsoft Azure Get Device Properties For A Specific Component", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/components/:componentName/properties", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "componentName", "value": "", "type": "path", "description": "Name of the device component." }, { "name": "unmodeled", "value": "", "type": "query", "description": "The query parameter for supporting unmodeled properties." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Replace Device Properties For A Specific Component", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/devices/:deviceId/components/:componentName/properties", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "componentName", "value": "", "type": "path", "description": "Name of the device component." }, { "name": "unmodeled", "value": "", "type": "query", "description": "The query parameter for supporting unmodeled properties." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Update Device Properties For A Specific Component Via Patch", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/devices/:deviceId/components/:componentName/properties", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "componentName", "value": "", "type": "path", "description": "Name of the device component." }, { "name": "unmodeled", "value": "", "type": "query", "description": "The query parameter for supporting unmodeled properties." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get Component Telemetry Value", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/components/:componentName/telemetry/:telemetryName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "componentName", "value": "", "type": "path", "description": "Name of the device component." }, { "name": "telemetryName", "value": "", "type": "path", "description": "Name of this device telemetry." } ] }, "docs": "Get the last telemetry value from a component." }, { "info": { "name": "Microsoft Azure Get Device Credentials", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/credentials", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure List The Modules Present In A Device", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/modules", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get Module Command History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/modules/:moduleName/commands/:commandName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "moduleName", "value": "", "type": "path", "description": "Name of the device module." }, { "name": "commandName", "value": "", "type": "path", "description": "Name of this device command." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Run A Module Command", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/devices/:deviceId/modules/:moduleName/commands/:commandName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "moduleName", "value": "", "type": "path", "description": "Name of the device module." }, { "name": "commandName", "value": "", "type": "path", "description": "Name of this device command." } ] }, "docs": "Run a command on a module." }, { "info": { "name": "Microsoft Azure List The Components Present In A Module", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/modules/:moduleName/components", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "moduleName", "value": "", "type": "path", "description": "Name of the device module." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get Module Component Command History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/modules/:moduleName/components/:componentName/commands/:commandName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "moduleName", "value": "", "type": "path", "description": "Name of the device module." }, { "name": "componentName", "value": "", "type": "path", "description": "Name of the device component." }, { "name": "commandName", "value": "", "type": "path", "description": "Name of this device command." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Run A Module Component Command", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/devices/:deviceId/modules/:moduleName/components/:componentName/commands/:commandName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "moduleName", "value": "", "type": "path", "description": "Name of the device module." }, { "name": "componentName", "value": "", "type": "path", "description": "Name of the device component." }, { "name": "commandName", "value": "", "type": "path", "description": "Name of this device command." } ] }, "docs": "Run a command on a module." }, { "info": { "name": "Microsoft Azure Get Module Properties For A Specific Component", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/modules/:moduleName/components/:componentName/properties", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "moduleName", "value": "", "type": "path", "description": "Name of the device module." }, { "name": "componentName", "value": "", "type": "path", "description": "Name of the device component." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Replace Module Properties For A Specific Component", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/devices/:deviceId/modules/:moduleName/components/:componentName/properties", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "moduleName", "value": "", "type": "path", "description": "Name of the device module." }, { "name": "componentName", "value": "", "type": "path", "description": "Name of the device component." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Update Module Properties For A Specific Component Via Patch", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/devices/:deviceId/modules/:moduleName/components/:componentName/properties", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "moduleName", "value": "", "type": "path", "description": "Name of the device module." }, { "name": "componentName", "value": "", "type": "path", "description": "Name of the device component." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get Module Component Telemetry Value", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/modules/:moduleName/components/:componentName/telemetry/:telemetryName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "moduleName", "value": "", "type": "path", "description": "Name of the device module." }, { "name": "componentName", "value": "", "type": "path", "description": "Name of the device component." }, { "name": "telemetryName", "value": "", "type": "path", "description": "Name of this device telemetry." } ] }, "docs": "Get the last telemetry value from a module component." }, { "info": { "name": "Microsoft Azure Get Module Properties", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/modules/:moduleName/properties", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "moduleName", "value": "", "type": "path", "description": "Name of the device module." } ] }, "docs": "Get all property values of a module." }, { "info": { "name": "Microsoft Azure Replace Module Properties", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/devices/:deviceId/modules/:moduleName/properties", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "moduleName", "value": "", "type": "path", "description": "Name of the device module." } ] }, "docs": "Replace all property values of a module." }, { "info": { "name": "Microsoft Azure Update Module Properties Via Patch", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/devices/:deviceId/modules/:moduleName/properties", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "moduleName", "value": "", "type": "path", "description": "Name of the device module." } ] }, "docs": "Update property values of a module." }, { "info": { "name": "Microsoft Azure Get Module Telemetry Value", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/modules/:moduleName/telemetry/:telemetryName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "moduleName", "value": "", "type": "path", "description": "Name of the device module." }, { "name": "telemetryName", "value": "", "type": "path", "description": "Name of this device telemetry." } ] }, "docs": "Get the last telemetry value from a module." }, { "info": { "name": "Microsoft Azure Get Device Properties", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/properties", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "unmodeled", "value": "", "type": "query", "description": "The query parameter for supporting unmodeled properties." } ] }, "docs": "Get all property values of a device by device ID." }, { "info": { "name": "Microsoft Azure Replace Device Properties", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/devices/:deviceId/properties", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "unmodeled", "value": "", "type": "query", "description": "The query parameter for supporting unmodeled properties." } ] }, "docs": "Replace all property values of a device by device ID." }, { "info": { "name": "Microsoft Azure Update Device Properties Via Patch", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/devices/:deviceId/properties", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "unmodeled", "value": "", "type": "query", "description": "The query parameter for supporting unmodeled properties." } ] }, "docs": "Update property values of a device by device ID." }, { "info": { "name": "Microsoft Azure Given The Id For An Upstream Device, Will Return The Upstream And The Downstream Relationships Associated With That Gateway These Downstream Relationships Are Only Those Associated With The Direct Downstream Level They Don’t Work Recursively", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/relationships", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "maxpagesize", "value": "", "type": "query", "description": "The maximum number of resources to return from one response." } ] }, "docs": "List all relationships based on device ID" }, { "info": { "name": "Microsoft Azure Given The Id For A Device And A Relationship Id Associated With This Device, Get The Details Of The Relationship", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/relationships/:relationshipId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "relationshipId", "value": "", "type": "path", "description": "Unique ID of a relationship between devices." } ] }, "docs": "Get device relationship by ID" }, { "info": { "name": "Microsoft Azure Given The Id For A Device And A Relationship Id Associated With This Device, Create A New Relationship For Between The Given Device And A Second Device Specified In The Body", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/devices/:deviceId/relationships/:relationshipId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "relationshipId", "value": "", "type": "path", "description": "Unique ID of a relationship between devices." } ] }, "docs": "Create a device relationship" }, { "info": { "name": "Microsoft Azure Patch A Given Relationship Given The Relationship Id And A Given Device Id", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/devices/:deviceId/relationships/:relationshipId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "relationshipId", "value": "", "type": "path", "description": "Unique ID of a relationship between devices." } ] }, "docs": "Update device relationship" }, { "info": { "name": "Microsoft Azure Given The Id For A Device And An Associated Relationship Id, Delete The Relationship The Given Device Id Can Be That Of The Upstream Or Downstream Device", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/devices/:deviceId/relationships/:relationshipId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "relationshipId", "value": "", "type": "path", "description": "Unique ID of a relationship between devices." } ] }, "docs": "Delete a device relationship" }, { "info": { "name": "Microsoft Azure Get Device Telemetry Value", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/devices/:deviceId/telemetry/:telemetryName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "deviceId", "value": "", "type": "path", "description": "Unique ID of the device." }, { "name": "telemetryName", "value": "", "type": "path", "description": "Name of this device telemetry." } ] }, "docs": "Get the last telemetry value from a device." }, { "info": { "name": "Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/devices", "params": [ { "name": "catalogName", "value": "", "type": "path", "description": "Name of catalog" }, { "name": "productName", "value": "", "type": "path", "description": "Name of product." }, { "name": "deviceGroupName", "value": "", "type": "path", "description": "Name of device group." } ] }, "docs": "List Device resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name." }, { "info": { "name": "Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/devices/:deviceName", "params": [ { "name": "catalogName", "value": "", "type": "path", "description": "Name of catalog" }, { "name": "productName", "value": "", "type": "path", "description": "Name of product." }, { "name": "deviceGroupName", "value": "", "type": "path", "description": "Name of device group." }, { "name": "deviceName", "value": "", "type": "path", "description": "Device name" } ] }, "docs": "Get a Device. Use '.unassigned' or '.default' for the device group and product names when a device does not belong to a device group and product." }, { "info": { "name": "Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/devices/:deviceName", "params": [ { "name": "catalogName", "value": "", "type": "path", "description": "Name of catalog" }, { "name": "productName", "value": "", "type": "path", "description": "Name of product." }, { "name": "deviceGroupName", "value": "", "type": "path", "description": "Name of device group." }, { "name": "deviceName", "value": "", "type": "path", "description": "Device name" } ] }, "docs": "Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only." }, { "info": { "name": "Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/devices/:deviceName", "params": [ { "name": "catalogName", "value": "", "type": "path", "description": "Name of catalog" }, { "name": "productName", "value": "", "type": "path", "description": "Name of product." }, { "name": "deviceGroupName", "value": "", "type": "path", "description": "Name of device group." }, { "name": "deviceName", "value": "", "type": "path", "description": "Device name" } ] }, "docs": "Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level." }, { "info": { "name": "Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/devices/:deviceName", "params": [ { "name": "catalogName", "value": "", "type": "path", "description": "Name of catalog" }, { "name": "productName", "value": "", "type": "path", "description": "Name of product." }, { "name": "deviceGroupName", "value": "", "type": "path", "description": "Name of device group." }, { "name": "deviceName", "value": "", "type": "path", "description": "Device name" } ] }, "docs": "Delete a Device" }, { "info": { "name": "Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename Generatecapabilityimage", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/products/:productName/deviceGroups/:deviceGroupName/devices/:deviceName/generateCapabilityImage", "params": [ { "name": "catalogName", "value": "", "type": "path", "description": "Name of catalog" }, { "name": "productName", "value": "", "type": "path", "description": "Name of product." }, { "name": "deviceGroupName", "value": "", "type": "path", "description": "Name of device group." }, { "name": "deviceName", "value": "", "type": "path", "description": "Device name" } ] }, "docs": "Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Databoxedge Databoxedgedevices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." }, { "name": "$expand", "value": "", "type": "query", "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list." } ] }, "docs": "Gets all the Data Box Edge/Data Box Gateway devices in a subscription." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." }, { "name": "$expand", "value": "", "type": "query", "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list." } ] }, "docs": "Gets all the Data Box Edge/Data Box Gateway devices in a resource group." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Gets the properties of the Data Box Edge/Data Box Gateway device." }, { "info": { "name": "Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Creates or updates a Data Box Edge/Data Box Gateway resource." }, { "info": { "name": "Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Modifies a Data Box Edge/Data Box Gateway resource." }, { "info": { "name": "Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Deletes the Data Box Edge/Data Box Gateway device." }, { "info": { "name": "Microsoft Azure Downloads The Updates On A Data Box Edge Data Box Gateway Device", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/downloadUpdates", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Generatecertificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/generateCertificate", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Generates certificate for activation key." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Getextendedinformation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/getExtendedInformation", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Gets additional information for the specified Azure Stack Edge/Data Box Gateway device." }, { "info": { "name": "Microsoft Azure Installs The Updates On The Data Box Edge Data Box Gateway Device", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/installUpdates", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Networksettings Default", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/networkSettings/default", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Gets the network settings of the specified Data Box Edge/Data Box Gateway device." }, { "info": { "name": "Microsoft Azure Scans For Updates On A Data Box Edge Data Box Gateway Device", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/scanForUpdates", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Securitysettings Default Update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/securitySettings/default/update", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Updates the security settings on a Data Box Edge/Data Box Gateway device." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Updateextendedinformation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/updateExtendedInformation", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Gets additional information for the specified Data Box Edge/Data Box Gateway device." }, { "info": { "name": "Microsoft Azure Gets Information About The Availability Of Updates Based On The Last Scan Of The Device It Also Gets Information About Any Ongoing Download Or Install Jobs On The Device", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/updateSummary/default", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Uploadcertificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/uploadCertificate", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Uploads registration certificate for the device." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Configuredevice", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/configureDevice", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Complete minimal setup before using the device." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" }, { "name": "$expand", "value": "", "type": "query", "description": "Specify $expand=details to populate additional fields related to the device or $expand=rolloverdetails to populate additional fields related to the service data encryption key rollover on device" } ] }, "docs": "Returns the list of devices for the specified manager." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" }, { "name": "$expand", "value": "", "type": "query", "description": "Specify $expand=details to populate additional fields related to the device or $expand=rolloverdetails to populate additional fields related to the service data encryption key rollover on device" } ] }, "docs": "Returns the properties of the specified device." }, { "info": { "name": "Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Patches the device." }, { "info": { "name": "Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Deletes the device." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Authorizeforserviceencryptionkeyrollover", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/authorizeForServiceEncryptionKeyRollover", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Authorizes the specified device for service data encryption key rollover." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Deactivate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/deactivate", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Deactivates the device." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Installupdates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/installUpdates", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Downloads and installs the updates on the device." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Listfailoversets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/listFailoverSets", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Returns all failover sets for a given device and their eligibility for participating in a failover. A failover set refers to a set of volume containers that need to be failed-over as a single unit to maintain data integrity." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/metrics", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" }, { "name": "$filter", "value": "", "type": "query", "description": "OData Filter options" } ] }, "docs": "Gets the metrics for the specified device." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Metricsdefinitions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/metricsDefinitions", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Gets the metric definitions for the specified device." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Scanforupdates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/scanForUpdates", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Scans for updates on the device." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Updatesummary Default", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/updateSummary/default", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Returns the update summary of the specified device name." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Sourcedevicename Failover", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:sourceDeviceName/failover", "params": [ { "name": "sourceDeviceName", "value": "", "type": "path", "description": "The source device name on which failover is performed." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Failovers a set of volume containers from a specified source device to a target device." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Sourcedevicename Listfailovertargets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:sourceDeviceName/listFailoverTargets", "params": [ { "name": "sourceDeviceName", "value": "", "type": "path", "description": "The source device name on which failover is performed." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Given a list of volume containers to be failed over from a source device, this method returns the eligibility result, as a failover target, for all devices under that resource." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Alertsettings Default", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/alertSettings/default", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Returns the alert settings of the specified device name." }, { "info": { "name": "Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Alertsettings Default", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/alertSettings/default", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Creates or updates the alert settings" }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Download", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/download", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Downloads updates on the device." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Failover", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/failover", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Fails over the device to another device." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Failovertargets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/failoverTargets", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" }, { "name": "$expand", "value": "", "type": "query", "description": "Specify $expand=details to populate additional fields related to the device." } ] }, "docs": "Retrieves all the devices which can be used as failover targets for the given device." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Install", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/install", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Installs the updates on the device." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Networksettings Default", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/networkSettings/default", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Returns the network settings of the specified device name." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Securitysettings Default Update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/securitySettings/default/update", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Creates or updates the security settings." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Timesettings Default", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/timeSettings/default", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Returns the time settings of the specified device name." } ] } ], "bundled": true }