swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Devices API
schemes:
- https
tags:
- name: Devices
paths:
  /sensor-partners/{sensorPartnerId}/devices:
    get:
      tags:
      - Devices
      description: Returns a paginated list of device resources.
      operationId: microsoftAzureDevicesList
      produces:
      - application/json
      parameters:
      - in: query
        name: parentDeviceIds
        description: Id's of the parent devices.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: deviceDataModelIds
        description: Id's of the device data models.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: path
        name: sensorPartnerId
        description: Id of the associated sensor partner.
        required: true
        type: string
      - in: query
        name: ids
        description: Ids of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: names
        description: Names of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: propertyFilters
        description: "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\"."
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: statuses
        description: Statuses of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: minCreatedDateTime
        description: Minimum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxCreatedDateTime
        description: Maximum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: minLastModifiedDateTime
        description: Minimum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxLastModifiedDateTime
        description: Maximum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxPageSize
        description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceListResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Devices_List:
          $ref: ./examples/Devices_List.json
      summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Devices
  /sensor-partners/{sensorPartnerId}/devices/{deviceId}:
    patch:
      tags:
      - Devices
      description: Create a device entity.
      operationId: microsoftAzureDevicesCreateorupdate
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: sensorPartnerId
        description: Id of the sensor partner.
        required: true
        type: string
      - in: path
        name: deviceId
        description: Id of the device resource.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: deviceDetails
        description: Device object details.
        required: true
        schema:
          $ref: '#/definitions/Device'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Device'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Device'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Devices_CreateOrUpdate:
          $ref: ./examples/Devices_CreateOrUpdate.json
      summary: Microsoft Azure Patch Sensor Partners Sensorpartnerid Devices Deviceid
    get:
      tags:
      - Devices
      description: Gets a device entity.
      operationId: microsoftAzureDevicesGet
      produces:
      - application/json
      parameters:
      - in: path
        name: sensorPartnerId
        description: Id of the sensor partner.
        required: true
        type: string
      - in: path
        name: deviceId
        description: Id of the device resource.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Device'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Devices_Get:
          $ref: ./examples/Devices_Get.json
      summary: Microsoft Azure Get Sensor Partners Sensorpartnerid Devices Deviceid
    delete:
      tags:
      - Devices
      description: Deletes a device entity.
      operationId: microsoftAzureDevicesDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: sensorPartnerId
        description: Id of the sensor partner.
        required: true
        type: string
      - in: path
        name: deviceId
        description: Id of the device resource.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '204':
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Devices_Delete:
          $ref: ./examples/Devices_Delete.json
      summary: Microsoft Azure Delete Sensor Partners Sensorpartnerid Devices Deviceid
  /devices:
    get:
      operationId: microsoftAzureDevicesList
      summary: 'Microsoft Azure Get The List Of Devices In An Application With Basic Odata Support Maxpagesize, Filter, Orderby , [more Details] Https: Aka Ms Iotcentralodatasupport'
      x-ms-examples:
        List devices:
          $ref: ./examples/devices_list.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/Filter'
      - $ref: '#/parameters/MaxPageSize'
      - $ref: '#/parameters/OrderBy'
      - $ref: '#/parameters/Expand'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}:
    get:
      operationId: microsoftAzureDevicesGet
      summary: Microsoft Azure Get A Device By Id
      description: Get details about an existing device by device ID.
      x-ms-examples:
        Get device by ID:
          $ref: ./examples/devices_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/Expand'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Device_2'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
    put:
      operationId: microsoftAzureDevicesCreate
      summary: Microsoft Azure Create Or Update A Device
      description: Create a new device.
      x-ms-examples:
        Create device:
          $ref: ./examples/devices_create.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - in: body
        name: body
        description: Device body.
        schema:
          $ref: '#/definitions/Device_2'
        required: true
      - $ref: '#/parameters/Expand'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Device_2'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
    patch:
      operationId: microsoftAzureDevicesUpdate
      summary: Microsoft Azure Update A Device Via Patch
      description: Update an existing device by ID.
      x-ms-examples:
        Update device:
          $ref: ./examples/devices_create.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - in: body
        name: body
        description: Device patch body.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/Expand'
      - $ref: '#/parameters/IfMatch'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Device_2'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
    delete:
      operationId: microsoftAzureDevicesRemove
      summary: Microsoft Azure Delete A Device
      description: Delete an existing device by device ID.
      x-ms-examples:
        Delete device:
          $ref: ./examples/devices_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/Expand'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/applyDeploymentManifest:
    post:
      operationId: microsoftAzureDevicesApplymanifest
      summary: Microsoft Azure Apply A Deployment Manifest To An Edge Device
      description: Apply a deployment manifest to an edge device.
      x-ms-examples:
        Apply device deployment manifest:
          $ref: ./examples/devices_applyDeploymentManifest.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - in: body
        name: body
        description: Deployment Manifest data.
        schema:
          $ref: '#/definitions/DeploymentManifest'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeploymentManifest'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/attestation:
    get:
      operationId: microsoftAzureDevicesGetattestation
      summary: Microsoft Azure Get Device Attestation
      x-ms-examples:
        Get device attestation:
          $ref: ./examples/devices_attestations_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Attestation'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    put:
      operationId: microsoftAzureDevicesCreateattestation
      summary: Microsoft Azure Create An Individual Device Attestation
      x-ms-examples:
        Create or update device attestation - Symmetric Key:
          $ref: ./examples/devices_attestations_set_symmetricKey.json
        Create or update device attestation - TPM:
          $ref: ./examples/devices_attestations_set_tpm.json
        Create or update device attestation - X509:
          $ref: ./examples/devices_attestations_set_x509.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - in: body
        name: body
        description: Individual device attestation body.
        schema:
          $ref: '#/definitions/Attestation'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Attestation'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    patch:
      operationId: microsoftAzureDevicesUpdateattestation
      summary: Microsoft Azure Update An Individual Device Attestation Via Patch
      x-ms-examples:
        Update device attestation - Symmetric Key:
          $ref: ./examples/devices_attestations_set_symmetricKey.json
        Update device attestation - TPM:
          $ref: ./examples/devices_attestations_set_tpm.json
        Update device attestation - X509:
          $ref: ./examples/devices_attestations_set_x509.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - in: body
        name: body
        description: Individual device attestation patch body.
        schema:
          type: object
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Attestation'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    delete:
      operationId: microsoftAzureDevicesRemoveattestation
      summary: Microsoft Azure Remove An Individual Device Attestation
      x-ms-examples:
        Delete device attestation:
          $ref: ./examples/devices_attestations_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}/commands/{commandName}:
    get:
      operationId: microsoftAzureDevicesGetcommandhistory
      summary: Microsoft Azure Get Device Command History
      x-ms-examples:
        Get command history:
          $ref: ./examples/devices_commandshistory_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/CommandName'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommandCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    post:
      operationId: microsoftAzureDevicesRuncommand
      summary: Microsoft Azure Run A Device Command
      description: Run a command on a device.
      x-ms-examples:
        Send command:
          $ref: ./examples/devices_commands_send.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/CommandName'
      - in: body
        name: body
        description: Device command body.
        schema:
          $ref: '#/definitions/DeviceCommand'
        required: true
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommand'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/components:
    get:
      operationId: microsoftAzureDevicesListcomponents
      summary: Microsoft Azure List The Components Present In A Device
      x-ms-examples:
        List components:
          $ref: ./examples/devices_components_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Collection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}/components/{componentName}/commands/{commandName}:
    get:
      operationId: microsoftAzureDevicesGetcomponentcommandhistory
      summary: Microsoft Azure Get Component Command History
      x-ms-examples:
        Get command history:
          $ref: ./examples/devices_commandshistory_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ComponentName'
      - $ref: '#/parameters/CommandName'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommandCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    post:
      operationId: microsoftAzureDevicesRuncomponentcommand
      summary: Microsoft Azure Run A Component Command
      description: Run a command on a component.
      x-ms-examples:
        Send command:
          $ref: ./examples/devices_commands_send.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ComponentName'
      - $ref: '#/parameters/CommandName'
      - in: body
        name: body
        description: Device command body.
        schema:
          $ref: '#/definitions/DeviceCommand'
        required: true
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommand'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/components/{componentName}/properties:
    get:
      operationId: microsoftAzureDevicesGetcomponentproperties
      summary: Microsoft Azure Get Device Properties For A Specific Component
      x-ms-examples:
        Get properties on components:
          $ref: ./examples/devices_properties_components_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ComponentName'
      - $ref: '#/parameters/Unmodeled'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    put:
      operationId: microsoftAzureDevicesReplacecomponentproperties
      summary: Microsoft Azure Replace Device Properties For A Specific Component
      x-ms-examples:
        Update properties on components:
          $ref: ./examples/devices_properties_components_set.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ComponentName'
      - in: body
        name: body
        description: Device properties.
        schema:
          $ref: '#/definitions/DeviceProperties'
        required: true
      - $ref: '#/parameters/Unmodeled'
      responses:
        '202':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    patch:
      operationId: microsoftAzureDevicesUpdatecomponentproperties
      summary: Microsoft Azure Update Device Properties For A Specific Component Via Patch
      x-ms-examples:
        Update properties on components:
          $ref: ./examples/devices_properties_components_set.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ComponentName'
      - in: body
        name: body
        description: Device properties patch.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/Unmodeled'
      responses:
        '202':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}/components/{componentName}/telemetry/{telemetryName}:
    get:
      operationId: microsoftAzureDevicesGetcomponenttelemetryvalue
      summary: Microsoft Azure Get Component Telemetry Value
      description: Get the last telemetry value from a component.
      x-ms-examples:
        Get telemetry:
          $ref: ./examples/devices_telemetry_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ComponentName'
      - $ref: '#/parameters/TelemetryName'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceTelemetry'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/credentials:
    get:
      operationId: microsoftAzureDevicesGetcredentials
      summary: Microsoft Azure Get Device Credentials
      x-ms-examples:
        Get device credentials:
          $ref: ./examples/devicecredentials_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCredentials'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}/modules:
    get:
      operationId: microsoftAzureDevicesListmodules
      summary: Microsoft Azure List The Modules Present In A Device
      x-ms-examples:
        List modules:
          $ref: ./examples/devices_modules_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Collection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}/modules/{moduleName}/commands/{commandName}:
    get:
      operationId: microsoftAzureDevicesGetmodulecommandhistory
      summary: Microsoft Azure Get Module Command History
      x-ms-examples:
        Get command history within module:
          $ref: ./examples/modules_commandshistory_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - $ref: '#/parameters/CommandName'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommandCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    post:
      operationId: microsoftAzureDevicesRunmodulecommand
      summary: Microsoft Azure Run A Module Command
      description: Run a command on a module.
      x-ms-examples:
        Send command to module:
          $ref: ./examples/modules_commands_send.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - $ref: '#/parameters/CommandName'
      - in: body
        name: body
        description: Device command body.
        schema:
          $ref: '#/definitions/DeviceCommand'
        required: true
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommand'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/modules/{moduleName}/components:
    get:
      operationId: microsoftAzureDevicesListmodulecomponents
      summary: Microsoft Azure List The Components Present In A Module
      x-ms-examples:
        List module components:
          $ref: ./examples/devices_modules_components_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Collection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/commands/{commandName}:
    get:
      operationId: microsoftAzureDevicesGetmodulecomponentcommandhistory
      summary: Microsoft Azure Get Module Component Command History
      x-ms-examples:
        Get command history within module:
          $ref: ./examples/modules_commandshistory_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - $ref: '#/parameters/ComponentName'
      - $ref: '#/parameters/CommandName'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommandCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    post:
      operationId: microsoftAzureDevicesRunmodulecomponentcommand
      summary: Microsoft Azure Run A Module Component Command
      description: Run a command on a module.
      x-ms-examples:
        Send command to module:
          $ref: ./examples/modules_commands_send.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - $ref: '#/parameters/ComponentName'
      - $ref: '#/parameters/CommandName'
      - in: body
        name: body
        description: Device command body.
        schema:
          $ref: '#/definitions/DeviceCommand'
        required: true
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/DeviceCommand'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties:
    get:
      operationId: microsoftAzureDevicesGetmodulecomponentproperties
      summary: Microsoft Azure Get Module Properties For A Specific Component
      x-ms-examples:
        Get properties of a module:
          $ref: ./examples/modules_properties_components_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - $ref: '#/parameters/ComponentName'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    put:
      operationId: microsoftAzureDevicesReplacemodulecomponentproperties
      summary: Microsoft Azure Replace Module Properties For A Specific Component
      x-ms-examples:
        Update properties of a module within a component:
          $ref: ./examples/modules_properties_components_set.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - $ref: '#/parameters/ComponentName'
      - in: body
        name: body
        description: Module properties.
        schema:
          $ref: '#/definitions/DeviceProperties'
        required: true
      responses:
        '202':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
    patch:
      operationId: microsoftAzureDevicesUpdatemodulecomponentproperties
      summary: Microsoft Azure Update Module Properties For A Specific Component Via Patch
      x-ms-examples:
        Update properties of a module within a component:
          $ref: ./examples/modules_properties_components_set.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - $ref: '#/parameters/ComponentName'
      - in: body
        name: body
        description: Module properties patch.
        schema:
          type: object
        required: true
      responses:
        '202':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      description: Needs a more full description created.
      tags:
      - Devices
  /devices/{deviceId}/modules/{moduleName}/components/{componentName}/telemetry/{telemetryName}:
    get:
      operationId: microsoftAzureDevicesGetmodulecomponenttelemetryvalue
      summary: Microsoft Azure Get Module Component Telemetry Value
      description: Get the last telemetry value from a module component.
      x-ms-examples:
        Get telemetry from module:
          $ref: ./examples/modules_telemetry_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - $ref: '#/parameters/ComponentName'
      - $ref: '#/parameters/TelemetryName'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceTelemetry'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/modules/{moduleName}/properties:
    get:
      operationId: microsoftAzureDevicesGetmoduleproperties
      summary: Microsoft Azure Get Module Properties
      description: Get all property values of a module.
      x-ms-examples:
        Get properties of a module:
          $ref: ./examples/modules_properties_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
    put:
      operationId: microsoftAzureDevicesReplacemoduleproperties
      summary: Microsoft Azure Replace Module Properties
      description: Replace all property values of a module.
      x-ms-examples:
        Update properties of a module:
          $ref: ./examples/modules_properties_update.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - in: body
        name: body
        description: Module properties.
        schema:
          $ref: '#/definitions/DeviceProperties'
        required: true
      responses:
        '202':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
    patch:
      operationId: microsoftAzureDevicesUpdatemoduleproperties
      summary: Microsoft Azure Update Module Properties Via Patch
      description: Update property values of a module.
      x-ms-examples:
        Update properties of a module:
          $ref: ./examples/modules_properties_update.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - in: body
        name: body
        description: Module properties patch.
        schema:
          type: object
        required: true
      responses:
        '202':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/modules/{moduleName}/telemetry/{telemetryName}:
    get:
      operationId: microsoftAzureDevicesGetmoduletelemetryvalue
      summary: Microsoft Azure Get Module Telemetry Value
      description: Get the last telemetry value from a module.
      x-ms-examples:
        Get telemetry from module:
          $ref: ./examples/modules_telemetry_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/ModuleName'
      - $ref: '#/parameters/TelemetryName'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceTelemetry'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/properties:
    get:
      operationId: microsoftAzureDevicesGetproperties
      summary: Microsoft Azure Get Device Properties
      description: Get all property values of a device by device ID.
      x-ms-examples:
        Get properties:
          $ref: ./examples/devices_properties_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/Unmodeled'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
    put:
      operationId: microsoftAzureDevicesReplaceproperties
      summary: Microsoft Azure Replace Device Properties
      description: Replace all property values of a device by device ID.
      x-ms-examples:
        Update properties:
          $ref: ./examples/devices_properties_update.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - in: body
        name: body
        description: Device properties.
        schema:
          $ref: '#/definitions/DeviceProperties'
        required: true
      - $ref: '#/parameters/Unmodeled'
      responses:
        '202':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
    patch:
      operationId: microsoftAzureDevicesUpdateproperties
      summary: Microsoft Azure Update Device Properties Via Patch
      description: Update property values of a device by device ID.
      x-ms-examples:
        Update properties:
          $ref: ./examples/devices_properties_update.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - in: body
        name: body
        description: Device properties patch.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/Unmodeled'
      responses:
        '202':
          description: Success
          schema:
            $ref: '#/definitions/DeviceProperties'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/relationships:
    get:
      operationId: microsoftAzureDevicesListrelationships
      summary: 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
      description: List all relationships based on device ID
      x-ms-examples:
        List device relationships:
          $ref: ./examples/devices_relationships_list.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/MaxPageSize'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceRelationshipCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/relationships/{relationshipId}:
    get:
      operationId: microsoftAzureDevicesGetrelationship
      summary: Microsoft Azure Given The Id For A Device And A Relationship Id Associated With This Device, Get The Details Of The Relationship
      description: Get device relationship by ID
      x-ms-examples:
        Get device relationship by ID:
          $ref: ./examples/devices_relationships_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/RelationshipId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceRelationship'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
    put:
      operationId: microsoftAzureDevicesCreaterelationship
      summary: 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
      description: Create a device relationship
      x-ms-examples:
        Create a new device relationship:
          $ref: ./examples/devices_relationships_create.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/RelationshipId'
      - in: body
        name: body
        description: Device relationship body.
        schema:
          $ref: '#/definitions/DeviceRelationship'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceRelationship'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
    patch:
      operationId: microsoftAzureDevicesUpdaterelationship
      summary: Microsoft Azure Patch A Given Relationship Given The Relationship Id And A Given Device Id
      description: Update device relationship
      x-ms-examples:
        Update a device relationship:
          $ref: ./examples/devices_relationships_update.json
      consumes:
      - application/json
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/RelationshipId'
      - in: body
        name: body
        description: Device relationship patch body.
        schema:
          type: object
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceRelationship'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
    delete:
      operationId: microsoftAzureDevicesRemoverelationship
      summary: 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
      description: Delete a device relationship
      x-ms-examples:
        Delete a device relationship:
          $ref: ./examples/devices_relationships_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/RelationshipId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  /devices/{deviceId}/telemetry/{telemetryName}:
    get:
      operationId: microsoftAzureDevicesGettelemetryvalue
      summary: Microsoft Azure Get Device Telemetry Value
      description: Get the last telemetry value from a device.
      x-ms-examples:
        Get telemetry:
          $ref: ./examples/devices_telemetry_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/DeviceId'
      - $ref: '#/parameters/TelemetryName'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeviceTelemetry'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error_2'
      tags:
      - Devices
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices
  : get:
      operationId: microsoftAzureDevicesListbydevicegroup
      tags:
      - Devices
      description: List Device resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        type: string
        pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        type: string
        pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        type: string
        pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/DeviceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Devices_ListByDeviceGroup:
          $ref: ./examples/GetDevices.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}
  : get:
      operationId: microsoftAzureDevicesGet
      tags:
      - Devices
      description: 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.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        type: string
        pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        type: string
        pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        type: string
        pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$
      - name: deviceName
        in: path
        description: Device name
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{128}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/Device_3'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Devices_Get:
          $ref: ./examples/GetDevice.json
      summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename
    put:
      operationId: microsoftAzureDevicesCreateorupdate
      tags:
      - Devices
      description: Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        type: string
        pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        type: string
        pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        type: string
        pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$
      - name: deviceName
        in: path
        description: Device name
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{128}$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/Device_3'
      responses:
        '200':
          description: Resource 'Device' update operation succeeded
          schema:
            $ref: '#/definitions/Device_3'
        '201':
          description: Resource 'Device' create operation succeeded
          schema:
            $ref: '#/definitions/Device_3'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Devices_CreateOrUpdate:
          $ref: ./examples/PutDevice.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename
    patch:
      operationId: microsoftAzureDevicesUpdate
      tags:
      - Devices
      description: Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        type: string
        pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        type: string
        pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        type: string
        pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$
      - name: deviceName
        in: path
        description: Device name
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{128}$
      - name: properties
        in: body
        description: The resource properties to be updated.
        required: true
        schema:
          $ref: '#/definitions/DeviceUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/Device_3'
        '202':
          description: Resource update request accepted.
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Devices_Update:
          $ref: ./examples/PatchDevice.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename
    delete:
      operationId: microsoftAzureDevicesDelete
      tags:
      - Devices
      description: Delete a Device
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        type: string
        pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        type: string
        pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        type: string
        pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$
      - name: deviceName
        in: path
        description: Device name
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{128}$
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Devices_Delete:
          $ref: ./examples/DeleteDevice.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}/generateCapabilityImage
  : post:
      operationId: microsoftAzureDevicesGeneratecapabilityimage
      tags:
      - Devices
      description: 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.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: catalogName
        in: path
        description: Name of catalog
        required: true
        type: string
        pattern: ^[A-Za-z0-9_-]{1,50}$
      - name: productName
        in: path
        description: Name of product.
        required: true
        type: string
        pattern: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$
      - name: deviceGroupName
        in: path
        description: Name of device group.
        required: true
        type: string
        pattern: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$
      - name: deviceName
        in: path
        description: Device name
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{128}$
      - name: generateDeviceCapabilityRequest
        in: body
        description: Generate capability image request body.
        required: true
        schema:
          $ref: '#/definitions/GenerateCapabilityImageRequest'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/SignedCapabilityImageResponse'
        '202':
          description: Resource operation accepted.
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Devices_GenerateCapabilityImage:
          $ref: ./examples/PostGenerateDeviceCapabilityImage.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Devices Devicename Generatecapabilityimage
  /subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices:
    get:
      tags:
      - Devices
      description: Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
      operationId: microsoftAzureDevicesListbysubscription
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - name: $expand
        in: query
        description: Specify $expand=details to populate additional fields related to the resource or Specify $skipToken=<token> to populate the next page in the list.
        required: false
        type: string
      responses:
        '200':
          description: The collection of Data Box Edge/Data Box Gateway devices.
          schema:
            $ref: '#/definitions/DataBoxEdgeDeviceList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        DataBoxEdgeDeviceGetBySubscription:
          $ref: ./examples/DataBoxEdgeDeviceGetBySubscription.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Databoxedge Databoxedgedevices
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices:
    get:
      tags:
      - Devices
      description: Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
      operationId: microsoftAzureDevicesListbyresourcegroup
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - name: $expand
        in: query
        description: Specify $expand=details to populate additional fields related to the resource or Specify $skipToken=<token> to populate the next page in the list.
        required: false
        type: string
      responses:
        '200':
          description: The collection of Data Box Edge/Data Box Gateway devices.
          schema:
            $ref: '#/definitions/DataBoxEdgeDeviceList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        DataBoxEdgeDeviceGetByResourceGroup:
          $ref: ./examples/DataBoxEdgeDeviceGetByResourceGroup.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}
  : get:
      tags:
      - Devices
      description: Gets the properties of the Data Box Edge/Data Box Gateway device.
      operationId: microsoftAzureDevicesGet
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The Data Box Edge/Data Box Gateway device.
          schema:
            $ref: '#/definitions/DataBoxEdgeDevice'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        DataBoxEdgeDeviceGetByName:
          $ref: ./examples/DataBoxEdgeDeviceGetByName.json
        DataBoxEdgeDeviceGetByNameWithDataResidency:
          $ref: ./examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename
    put:
      tags:
      - Devices
      description: Creates or updates a Data Box Edge/Data Box Gateway resource.
      operationId: microsoftAzureDevicesCreateorupdate
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: dataBoxEdgeDevice
        in: body
        description: The resource object.
        required: true
        schema:
          $ref: '#/definitions/DataBoxEdgeDevice'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the resource.
          schema:
            $ref: '#/definitions/DataBoxEdgeDevice'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        DataBoxEdgeDevicePut:
          $ref: ./examples/DataBoxEdgeDevicePut.json
        DataBoxEdgeDevicePutWithDataResidency:
          $ref: ./examples/DataBoxEdgeDevicePutWithDataResidency.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename
    delete:
      tags:
      - Devices
      description: Deletes the Data Box Edge/Data Box Gateway device.
      operationId: microsoftAzureDevicesDelete
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the resource.
        '204':
          description: The resource is already deleted.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        DataBoxEdgeDeviceDelete:
          $ref: ./examples/DataBoxEdgeDeviceDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename
    patch:
      tags:
      - Devices
      description: Modifies a Data Box Edge/Data Box Gateway resource.
      operationId: microsoftAzureDevicesUpdate
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: parameters
        in: body
        description: The resource parameters.
        required: true
        schema:
          $ref: '#/definitions/DataBoxEdgeDevicePatch'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully updated the resource.
          schema:
            $ref: '#/definitions/DataBoxEdgeDevice'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        DataBoxEdgeDevicePatch:
          $ref: ./examples/DataBoxEdgeDevicePatch.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates
  : post:
      tags:
      - Devices
      summary: Microsoft Azure Downloads The Updates On A Data Box Edge Data Box Gateway Device
      operationId: microsoftAzureDevicesDownloadupdates
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully downloaded the updates on the device.
        '202':
          description: Accepted the request to download the updates on the device.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        DownloadUpdatesPost:
          $ref: ./examples/DownloadUpdatesPost.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/generateCertificate
  : post:
      tags:
      - Devices
      description: Generates certificate for activation key.
      operationId: microsoftAzureDevicesGeneratecertificate
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully generated self signed certificate.
          schema:
            $ref: '#/definitions/GenerateCertResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        GenerateCertificate:
          $ref: ./examples/GenerateCertificate.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Generatecertificate
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation
  : post:
      tags:
      - Devices
      description: Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.
      operationId: microsoftAzureDevicesGetextendedinformation
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The additional information.
          schema:
            $ref: '#/definitions/DataBoxEdgeDeviceExtendedInfo'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        ExtendedInfoPost:
          $ref: ./examples/ExtendedInfoPost.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Getextendedinformation
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates
  : post:
      tags:
      - Devices
      summary: Microsoft Azure Installs The Updates On The Data Box Edge Data Box Gateway Device
      operationId: microsoftAzureDevicesInstallupdates
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully installed updates on the device.
        '202':
          description: Accepted the request to install updates on the device.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        InstallUpdatesPost:
          $ref: ./examples/InstallUpdatesPost.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default
  : get:
      tags:
      - Devices
      description: Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
      operationId: microsoftAzureDevicesGetnetworksettings
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The device network settings.
          schema:
            $ref: '#/definitions/NetworkSettings'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        NetworkSettingsGet:
          $ref: ./examples/NetworkSettingsGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Networksettings Default
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates
  : post:
      tags:
      - Devices
      summary: Microsoft Azure Scans For Updates On A Data Box Edge Data Box Gateway Device
      operationId: microsoftAzureDevicesScanforupdates
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully scanned the device for updates.
        '202':
          description: Accepted the request to scan for updates on the device.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        ScanForUpdatesPost:
          $ref: ./examples/ScanForUpdatesPost.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update
  : post:
      tags:
      - Devices
      description: Updates the security settings on a Data Box Edge/Data Box Gateway device.
      operationId: microsoftAzureDevicesCreateorupdatesecuritysettings
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: securitySettings
        in: body
        description: The security settings.
        required: true
        schema:
          $ref: '#/definitions/SecuritySettings'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '202':
          description: Accepted the request to update the security settings.
        '204':
          description: Updated the security settings.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        CreateOrUpdateSecuritySettings:
          $ref: ./examples/SecuritySettingsUpdatePost.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Securitysettings Default Update
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateExtendedInformation
  : post:
      tags:
      - Devices
      description: Gets additional information for the specified Data Box Edge/Data Box Gateway device.
      operationId: microsoftAzureDevicesUpdateextendedinformation
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: parameters
        in: body
        description: The patch object.
        required: true
        schema:
          $ref: '#/definitions/DataBoxEdgeDeviceExtendedInfoPatch'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Modify additional information.
          schema:
            $ref: '#/definitions/DataBoxEdgeDeviceExtendedInfo'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        GetUpdateExtendedInfo:
          $ref: ./examples/GetUpdateExtendedInfo.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Updateextendedinformation
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default
  : get:
      tags:
      - Devices
      summary: 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
      operationId: microsoftAzureDevicesGetupdatesummary
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The update summary.
          schema:
            $ref: '#/definitions/UpdateSummary'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        UpdateSummaryGet:
          $ref: ./examples/UpdateSummaryGet.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate
  : post:
      tags:
      - Devices
      description: Uploads registration certificate for the device.
      operationId: microsoftAzureDevicesUploadcertificate
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: parameters
        in: body
        description: The upload certificate request.
        required: true
        schema:
          $ref: '#/definitions/UploadCertificateRequest'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully uploaded the registration certificate.
          schema:
            $ref: '#/definitions/UploadCertificateResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        UploadCertificatePost:
          $ref: ./examples/UploadCertificatePost.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Uploadcertificate
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/configureDevice
  : post:
      tags:
      - Devices
      description: Complete minimal setup before using the device.
      operationId: microsoftAzureDevicesConfigure
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: parameters
        in: body
        description: The minimal properties to configure a device.
        required: true
        schema:
          $ref: '#/definitions/ConfigureDeviceRequest'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '202':
          description: Accepted the request to configure device.
        '204':
          description: Successfully configured the device.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DevicesConfigure:
          $ref: ./examples/DevicesConfigure.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Configuredevice
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices
  : get:
      tags:
      - Devices
      description: Returns the list of devices for the specified manager.
      operationId: microsoftAzureDevicesListbymanager
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      - name: $expand
        in: 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
        required: false
        type: string
      responses:
        '200':
          description: The collection of devices.
          schema:
            $ref: '#/definitions/DeviceList'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        DevicesListByManager:
          $ref: ./examples/DevicesListByManager.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}
  : get:
      tags:
      - Devices
      description: Returns the properties of the specified device.
      operationId: microsoftAzureDevicesGet
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      - name: $expand
        in: 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
        required: false
        type: string
      responses:
        '200':
          description: The device.
          schema:
            $ref: '#/definitions/Device_4'
      deprecated: false
      x-ms-examples:
        DevicesGet:
          $ref: ./examples/DevicesGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename
    delete:
      tags:
      - Devices
      description: Deletes the device.
      operationId: microsoftAzureDevicesDelete
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '202':
          description: Accepted the request to delete the device.
        '204':
          description: Successfully deleted the device.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DevicesDelete:
          $ref: ./examples/DevicesDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename
    patch:
      tags:
      - Devices
      description: Patches the device.
      operationId: microsoftAzureDevicesUpdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - name: parameters
        in: body
        description: Patch representation of the device.
        required: true
        schema:
          $ref: '#/definitions/DevicePatch'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '200':
          description: Successfully patched the device.
          schema:
            $ref: '#/definitions/Device_4'
      deprecated: false
      x-ms-examples:
        DevicesUpdate:
          $ref: ./examples/DevicesUpdate.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/authorizeForServiceEncryptionKeyRollover
  : post:
      tags:
      - Devices
      description: Authorizes the specified device for service data encryption key rollover.
      operationId: microsoftAzureDevicesAuthorizeforserviceencryptionkeyrollover
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '204':
          description: Successfully authorized the device for service encryption key rollover
      deprecated: false
      x-ms-examples:
        DevicesAuthorizeForServiceEncryptionKeyRollover:
          $ref: ./examples/DevicesAuthorizeForServiceEncryptionKeyRollover.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Authorizeforserviceencryptionkeyrollover
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/deactivate
  : post:
      tags:
      - Devices
      description: Deactivates the device.
      operationId: microsoftAzureDevicesDeactivate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '202':
          description: Accepted the request to deactivate the device.
        '204':
          description: Successfully deactivated the device.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DevicesDeactivate:
          $ref: ./examples/DevicesDeactivate.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Deactivate
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/installUpdates
  : post:
      tags:
      - Devices
      description: Downloads and installs the updates on the device.
      operationId: microsoftAzureDevicesInstallupdates
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '202':
          description: Accepted the request to download and install updates.
        '204':
          description: Successfully installed updates.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DevicesInstallUpdates:
          $ref: ./examples/DevicesInstallUpdates.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Installupdates
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/listFailoverSets
  : post:
      tags:
      - Devices
      description: 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.
      operationId: microsoftAzureDevicesListfailoversets
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '200':
          description: Returns the list of failover sets on the given device.
          schema:
            $ref: '#/definitions/FailoverSetsList'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        DevicesListFailoverSets:
          $ref: ./examples/DevicesListFailoverSets.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Listfailoversets
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/metrics
  : get:
      tags:
      - Devices
      description: Gets the metrics for the specified device.
      operationId: microsoftAzureDevicesListmetrics
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      - name: $filter
        in: query
        description: OData Filter options
        required: true
        type: string
      responses:
        '200':
          description: The collection of metrics.
          schema:
            $ref: '#/definitions/MetricList'
      deprecated: false
      x-ms-odata: '#/definitions/MetricFilter'
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        DevicesListMetrics:
          $ref: ./examples/DevicesListMetrics.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Metrics
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/metricsDefinitions
  : get:
      tags:
      - Devices
      description: Gets the metric definitions for the specified device.
      operationId: microsoftAzureDevicesListmetricdefinition
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '200':
          description: The collection of metric definitions.
          schema:
            $ref: '#/definitions/MetricDefinitionList'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        DevicesListMetricDefinition:
          $ref: ./examples/DevicesListMetricDefinition.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Metricsdefinitions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/scanForUpdates
  : post:
      tags:
      - Devices
      description: Scans for updates on the device.
      operationId: microsoftAzureDevicesScanforupdates
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '202':
          description: Accepted the request to scan for updates.
        '204':
          description: Successfully scanned for updates.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DevicesScanForUpdates:
          $ref: ./examples/DevicesScanForUpdates.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Scanforupdates
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/updateSummary/default
  : get:
      tags:
      - Devices
      description: Returns the update summary of the specified device name.
      operationId: microsoftAzureDevicesGetupdatesummary
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '200':
          description: The update summary.
          schema:
            $ref: '#/definitions/Updates'
      deprecated: false
      x-ms-examples:
        DevicesGetUpdateSummary:
          $ref: ./examples/DevicesGetUpdateSummary.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Updatesummary Default
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{sourceDeviceName}/failover
  : post:
      tags:
      - Devices
      description: Failovers a set of volume containers from a specified source device to a target device.
      operationId: microsoftAzureDevicesFailover
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: sourceDeviceName
        in: path
        description: The source device name on which failover is performed.
        required: true
        type: string
        x-ms-skip-url-encoding: true
      - name: parameters
        in: body
        description: FailoverRequest containing the source device and the list of volume containers to be failed over.
        required: true
        schema:
          $ref: '#/definitions/FailoverRequest'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '202':
          description: Accepted the request to failover the device.
        '204':
          description: Successfully completed failover of the device.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DevicesFailover:
          $ref: ./examples/DevicesFailover.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Sourcedevicename Failover
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{sourceDeviceName}/listFailoverTargets
  : post:
      tags:
      - Devices
      description: 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.
      operationId: microsoftAzureDevicesListfailovertargets
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: sourceDeviceName
        in: path
        description: The source device name on which failover is performed.
        required: true
        type: string
        x-ms-skip-url-encoding: true
      - name: parameters
        in: body
        description: ListFailoverTargetsRequest containing the list of volume containers to be failed over.
        required: true
        schema:
          $ref: '#/definitions/ListFailoverTargetsRequest'
      - $ref: '#/parameters/subscriptionIdParameter_2'
      - $ref: '#/parameters/resourceGroupNameParameter_2'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter_2'
      responses:
        '200':
          description: The list of target devices and their eligibility for failover.
          schema:
            $ref: '#/definitions/FailoverTargetsList'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        DevicesListFailoverTargets:
          $ref: ./examples/DevicesListFailoverTargets.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Sourcedevicename Listfailovertargets
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/alertSettings/default
  : get:
      tags:
      - Devices
      description: Returns the alert settings of the specified device name.
      operationId: microsoftAzureDevicesGetalertsettings
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter_3'
      - $ref: '#/parameters/resourceGroupNameParameter_3'
      - $ref: '#/parameters/managerNameParameter_2'
      - $ref: '#/parameters/apiVersionParameter_3'
      responses:
        '200':
          description: The alert settings.
          schema:
            $ref: '#/definitions/AlertSettings'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error_3'
      deprecated: false
      x-ms-examples:
        DevicesGetAlertSettings:
          $ref: ./examples/DevicesGetAlertSettings.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Alertsettings Default
    put:
      tags:
      - Devices
      description: Creates or updates the alert settings
      operationId: microsoftAzureDevicesCreateorupdatealertsettings
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: alertSettings
        in: body
        description: The alert settings.
        required: true
        schema:
          $ref: '#/definitions/AlertSettings'
      - $ref: '#/parameters/subscriptionIdParameter_3'
      - $ref: '#/parameters/resourceGroupNameParameter_3'
      - $ref: '#/parameters/managerNameParameter_2'
      - $ref: '#/parameters/apiVersionParameter_3'
      responses:
        '200':
          description: Successfully created or updated the network settings.
          schema:
            $ref: '#/definitions/AlertSettings'
        '202':
          description: Accepted the request to create or update the network settings.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error_3'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DevicesCreateOrUpdateAlertSettings:
          $ref: ./examples/DevicesCreateOrUpdateAlertSettings.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Alertsettings Default
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/download
  : post:
      tags:
      - Devices
      description: Downloads updates on the device.
      operationId: microsoftAzureDevicesDownloadupdates
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter_3'
      - $ref: '#/parameters/resourceGroupNameParameter_3'
      - $ref: '#/parameters/managerNameParameter_2'
      - $ref: '#/parameters/apiVersionParameter_3'
      responses:
        '202':
          description: Accepted the request to download updates.
        '204':
          description: Successfully downloaded updates.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error_3'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DevicesDownloadUpdates:
          $ref: ./examples/DevicesDownloadUpdates.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Download
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/failover
  : post:
      tags:
      - Devices
      description: Fails over the device to another device.
      operationId: microsoftAzureDevicesFailover
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: failoverRequest
        in: body
        description: The failover request.
        required: true
        schema:
          $ref: '#/definitions/FailoverRequest_2'
      - $ref: '#/parameters/subscriptionIdParameter_3'
      - $ref: '#/parameters/resourceGroupNameParameter_3'
      - $ref: '#/parameters/managerNameParameter_2'
      - $ref: '#/parameters/apiVersionParameter_3'
      responses:
        '202':
          description: Accepted the request to failover the device.
        '204':
          description: Successfully completed failover of the device.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error_3'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DevicesFailover:
          $ref: ./examples/DevicesFailover.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Failover
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/failoverTargets
  : get:
      tags:
      - Devices
      description: Retrieves all the devices which can be used as failover targets for the given device.
      operationId: microsoftAzureDevicesListfailovertarget
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter_3'
      - $ref: '#/parameters/resourceGroupNameParameter_3'
      - $ref: '#/parameters/managerNameParameter_2'
      - $ref: '#/parameters/apiVersionParameter_3'
      - name: $expand
        in: query
        description: Specify $expand=details to populate additional fields related to the device.
        required: false
        type: string
      responses:
        '200':
          description: The collection of devices for failover.
          schema:
            $ref: '#/definitions/DeviceList_2'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error_3'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        DevicesListFailoverTarget:
          $ref: ./examples/DevicesListFailoverTarget.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Failovertargets
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/install
  : post:
      tags:
      - Devices
      description: Installs the updates on the device.
      operationId: microsoftAzureDevicesInstallupdates
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter_3'
      - $ref: '#/parameters/resourceGroupNameParameter_3'
      - $ref: '#/parameters/managerNameParameter_2'
      - $ref: '#/parameters/apiVersionParameter_3'
      responses:
        '202':
          description: Accepted the request to install updates.
        '204':
          description: Successfully installed updates.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error_3'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DevicesInstallUpdates:
          $ref: ./examples/DevicesInstallUpdates.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Install
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/networkSettings/default
  : get:
      tags:
      - Devices
      description: Returns the network settings of the specified device name.
      operationId: microsoftAzureDevicesGetnetworksettings
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter_3'
      - $ref: '#/parameters/resourceGroupNameParameter_3'
      - $ref: '#/parameters/managerNameParameter_2'
      - $ref: '#/parameters/apiVersionParameter_3'
      responses:
        '200':
          description: The network settings.
          schema:
            $ref: '#/definitions/NetworkSettings_2'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error_3'
      deprecated: false
      x-ms-examples:
        DevicesGetNetworkSettings:
          $ref: ./examples/DevicesGetNetworkSettings.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Networksettings Default
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/securitySettings/default/update
  : post:
      tags:
      - Devices
      description: Creates or updates the security settings.
      operationId: microsoftAzureDevicesCreateorupdatesecuritysettings
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: securitySettings
        in: body
        description: The security settings.
        required: true
        schema:
          $ref: '#/definitions/SecuritySettings_2'
      - $ref: '#/parameters/subscriptionIdParameter_3'
      - $ref: '#/parameters/resourceGroupNameParameter_3'
      - $ref: '#/parameters/managerNameParameter_2'
      - $ref: '#/parameters/apiVersionParameter_3'
      responses:
        '202':
          description: Accepted the request to create or update the security settings.
        '204':
          description: Successfully updated security settings.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error_3'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DevicesCreateOrUpdateSecuritySettings:
          $ref: ./examples/DevicesCreateOrUpdateSecuritySettings.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Securitysettings Default Update
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/timeSettings/default
  : get:
      tags:
      - Devices
      description: Returns the time settings of the specified device name.
      operationId: microsoftAzureDevicesGettimesettings
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter_3'
      - $ref: '#/parameters/resourceGroupNameParameter_3'
      - $ref: '#/parameters/managerNameParameter_2'
      - $ref: '#/parameters/apiVersionParameter_3'
      responses:
        '200':
          description: The time settings.
          schema:
            $ref: '#/definitions/TimeSettings'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error_3'
      deprecated: false
      x-ms-examples:
        DevicesGetTimeSettings:
          $ref: ./examples/DevicesGetTimeSettings.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Timesettings Default
definitions:
  SecuritySettings_2:
    description: The SecuritySettings of a device
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel_2'
    properties:
      properties:
        $ref: '#/definitions/SecuritySettingsProperties_2'
        description: Properties of the SecuritySettings.
        x-ms-client-flatten: true
  DeviceDetails:
    description: The additional device details regarding the end point count and volume container count.
    type: object
    properties:
      endpointCount:
        format: int32
        description: The total number of endpoints that are currently on the device ( i.e. number of volumes).
        type: integer
      volumeContainerCount:
        format: int32
        description: The total number of volume containers on the device.
        type: integer
  TargetEligibilityResult:
    description: The eligibility result of device, as a failover target device.
    type: object
    properties:
      eligibilityStatus:
        description: The eligibility status of device, as a failover target device.
        enum:
        - NotEligible
        - Eligible
        type: string
        x-ms-enum:
          name: TargetEligibilityStatus
          modelAsString: false
      messages:
        description: The list of error messages, if a device does not qualify as a failover target device.
        type: array
        items:
          $ref: '#/definitions/TargetEligibilityErrorMessage'
        x-ms-identifiers: []
  VolumeContainerFailoverMetadata:
    description: The metadata of the volume container, that is being considered as part of a failover set.
    type: object
    properties:
      volumeContainerId:
        description: The path ID of the volume container.
        type: string
      volumes:
        description: The list of metadata of volumes inside the volume container, which contains valid cloud snapshots.
        type: array
        items:
          $ref: '#/definitions/VolumeFailoverMetadata'
        x-ms-identifiers: []
  Error_2:
    description: The response error definition.
    type: object
    properties:
      error:
        description: Error details for current request.
        $ref: '#/definitions/ErrorDetails'
    required:
    - error
  EdgeProfilePatch:
    description: The Data Box Edge/Gateway Edge Profile patch.
    type: object
    properties:
      subscription:
        $ref: '#/definitions/EdgeProfileSubscriptionPatch'
        description: The Data Box Edge/Gateway Edge Profile Subscription patch
  NetworkAdapter:
    description: Represents the networkAdapter on a device.
    type: object
    properties:
      adapterId:
        description: Instance ID of network adapter.
        type: string
        readOnly: true
      adapterPosition:
        $ref: '#/definitions/NetworkAdapterPosition'
        description: Hardware position of network adapter.
        readOnly: true
      index:
        format: int32
        description: Logical index of the adapter.
        type: integer
        readOnly: true
      nodeId:
        description: Node ID of the network adapter.
        type: string
        readOnly: true
      networkAdapterName:
        description: Network adapter name.
        type: string
        readOnly: true
      label:
        description: Hardware label for the adapter.
        type: string
        readOnly: true
      macAddress:
        description: MAC address.
        type: string
        readOnly: true
      linkSpeed:
        format: int64
        description: Link speed.
        type: integer
        readOnly: true
      status:
        description: Value indicating whether this adapter is valid.
        enum:
        - Inactive
        - Active
        type: string
        readOnly: true
        x-ms-enum:
          name: NetworkAdapterStatus
          modelAsString: true
      rdmaStatus:
        description: Value indicating whether this adapter is RDMA capable.
        enum:
        - Incapable
        - Capable
        type: string
        x-ms-enum:
          name: NetworkAdapterRDMAStatus
          modelAsString: true
      dhcpStatus:
        description: Value indicating whether this adapter has DHCP enabled.
        enum:
        - Disabled
        - Enabled
        type: string
        x-ms-enum:
          name: NetworkAdapterDHCPStatus
          modelAsString: true
      ipv4Configuration:
        $ref: '#/definitions/Ipv4Config'
        description: The IPv4 configuration of the network adapter.
        readOnly: true
      ipv6Configuration:
        $ref: '#/definitions/Ipv6Config'
        description: The IPv6 configuration of the network adapter.
        readOnly: true
      ipv6LinkLocalAddress:
        description: The IPv6 local address.
        type: string
        readOnly: true
      dnsServers:
        description: The list of DNS Servers of the device.
        uniqueItems: false
        type: array
        items:
          type: string
        readOnly: true
        x-ms-identifiers: []
  X509:
    description: The X509 definition.
    type: object
    properties:
      clientCertificates:
        description: The X.509 client certificates for this credential.
        $ref: '#/definitions/X509Certificates'
  NodeNetwork:
    description: Represents a single node in a device.
    required:
    - networkAdapters
    type: object
    properties:
      networkAdapters:
        description: The array of network adapters in the node.
        type: array
        items:
          $ref: '#/definitions/NetworkAdapter_2'
        x-ms-identifiers:
        - networkAdapterName
  AsymmetricEncryptedSecret_2:
    description: This class can be used as the Type for any secret entity represented as Password, CertThumbprint, Algorithm. This class is intended to be used when the secret is encrypted with an asymmetric key pair. The encryptionAlgorithm field is mainly for future usage to potentially allow different entities encrypted using different algorithms.
    required:
    - value
    - encryptionAlgorithm
    type: object
    properties:
      value:
        description: The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null.
        type: string
      encryptionCertificateThumbprint:
        description: Thumbprint certificate that was used to encrypt "Value"
        type: string
      encryptionAlgorithm:
        description: Algorithm used to encrypt "Value"
        enum:
        - None
        - AES256
        - RSAES_PKCS1_v_1_5
        type: string
        x-ms-enum:
          name: EncryptionAlgorithm
          modelAsString: false
  DeviceProperties:
    description: Property values associated with the device.
    type: object
    additionalProperties: true
  MetricDimension:
    description: The metric dimension. It indicates the source of the metric.
    type: object
    properties:
      name:
        description: The metric dimension name.
        type: string
      value:
        description: The metric dimension values.
        type: string
  TimeSettings:
    description: The TimeSettings of a device
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel_2'
    properties:
      properties:
        $ref: '#/definitions/TimeSettingsProperties'
        description: Properties of the TimeSettings.
        x-ms-client-flatten: true
  SecuritySettingsProperties_2:
    description: The properties of SecuritySettings
    required:
    - deviceAdminPassword
    type: object
    properties:
      deviceAdminPassword:
        $ref: '#/definitions/AsymmetricEncryptedSecret_2'
        description: 'Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to log into the  local web UI of the device. Actual password could have at least 8 characters that are a combination of  uppercase, lowercase, numeric, and special characters'
  BaseModel:
    description: Represents the base class for all other ARM object models
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the object.
        type: string
        readOnly: true
      name:
        description: The name of the object.
        type: string
        readOnly: true
      type:
        description: The hierarchical type of the object.
        type: string
        readOnly: true
      kind:
        description: The Kind of the object. Currently only Series8000 is supported
        enum:
        - Series8000
        type: string
        x-ms-enum:
          name: Kind
          modelAsString: false
  DeviceCredentials:
    description: The device credentials definition.
    type: object
    properties:
      idScope:
        description: ID scope for connecting to the IoT Central application.
        type: string
      symmetricKey:
        description: The symmetric key credentials for the device.
        $ref: '#/definitions/SymmetricKey'
      x509:
        description: The X.509 credential information for the device.
        $ref: '#/definitions/X509'
      tpm:
        description: The TPM credentials for the device.
        $ref: '#/definitions/Tpm'
    required:
    - idScope
  VolumeFailoverMetadata:
    description: The metadata of a volume that has valid cloud snapshot.
    type: object
    properties:
      volumeId:
        description: The path ID of the volume.
        type: string
      volumeType:
        description: The type of the volume.
        enum:
        - Tiered
        - Archival
        - LocallyPinned
        type: string
        x-ms-enum:
          name: VolumeType
          modelAsString: false
      sizeInBytes:
        format: int64
        description: The size of the volume in bytes at the time the snapshot was taken.
        type: integer
      backupCreatedDate:
        format: date-time
        description: The date at which the snapshot was taken.
        type: string
      backupElementId:
        description: The path ID of the backup-element for this volume, inside the backup set.
        type: string
      backupId:
        description: The path ID of the backup set.
        type: string
      backupPolicyId:
        description: The path ID of the backup policy using which the snapshot was taken.
        type: string
  UploadCertificateResponse:
    description: The upload registration certificate response.
    type: object
    properties:
      authType:
        description: Specifies authentication type.
        enum:
        - Invalid
        - AzureActiveDirectory
        type: string
        x-ms-enum:
          name: AuthenticationType
          modelAsString: true
      resourceId:
        description: The resource ID of the Data Box Edge/Gateway device.
        type: string
        readOnly: true
      aadAuthority:
        description: Azure Active Directory tenant authority.
        type: string
        readOnly: true
      aadTenantId:
        description: Azure Active Directory tenant ID.
        type: string
        readOnly: true
      servicePrincipalClientId:
        description: Azure Active Directory service principal client ID.
        type: string
        readOnly: true
      servicePrincipalObjectId:
        description: Azure Active Directory service principal object ID.
        type: string
        readOnly: true
      azureManagementEndpointAudience:
        description: The azure management endpoint audience.
        type: string
        readOnly: true
      aadAudience:
        description: Identifier of the target resource that is the recipient of the requested token.
        type: string
        readOnly: true
  DeviceRolloverDetails:
    description: The additional device details for the service data encryption key rollover.
    type: object
    properties:
      authorizationEligibility:
        description: The eligibility status of device for service data encryption key rollover.
        enum:
        - InEligible
        - Eligible
        type: string
        x-ms-enum:
          name: AuthorizationEligibility
          modelAsString: false
      authorizationStatus:
        description: The authorization status of the device for service data encryption key rollover.
        enum:
        - Disabled
        - Enabled
        type: string
        x-ms-enum:
          name: AuthorizationStatus
          modelAsString: false
      inEligibilityReason:
        description: The reason for inEligibility of device, in case it's not eligible for service data encryption key rollover.
        enum:
        - DeviceNotOnline
        - NotSupportedAppliance
        - RolloverPending
        type: string
        x-ms-enum:
          name: InEligibilityCategory
          modelAsString: false
  Metrics:
    description: The monitoring metric.
    type: object
    properties:
      resourceId:
        description: The ID of metric source.
        type: string
      startTime:
        format: date-time
        description: The start time of the metric data.
        type: string
      endTime:
        format: date-time
        description: The end time of the metric data.
        type: string
      timeGrain:
        description: The time granularity of the metric data.
        type: string
      primaryAggregation:
        description: The metric aggregation type.
        enum:
        - Average
        - Last
        - Maximum
        - Minimum
        - None
        - Total
        type: string
        x-ms-enum:
          name: MetricAggregationType
          modelAsString: false
      name:
        $ref: '#/definitions/MetricName'
        description: The name of the metric.
      dimensions:
        description: The metric dimensions.
        type: array
        items:
          $ref: '#/definitions/MetricDimension'
        x-ms-identifiers:
        - name
      unit:
        description: The unit of the metric data.
        enum:
        - Bytes
        - BytesPerSecond
        - Count
        - CountPerSecond
        - Percent
        - Seconds
        type: string
        x-ms-enum:
          name: MetricUnit
          modelAsString: false
      type:
        description: The type of the metric data.
        type: string
      values:
        description: The list of the metric data.
        type: array
        items:
          $ref: '#/definitions/MetricData'
        x-ms-identifiers:
        - timeStamp
  NetworkSettingsProperties_2:
    description: The properties of NetworkSettings
    required:
    - primaryDnsServer
    - nodeNetworks
    type: object
    properties:
      primaryDnsServer:
        description: The Primary DNS server for the device
        type: string
      secondaryDnsServer:
        description: The secondary DNS server for the device
        type: string
      nodeNetworks:
        description: The NetworkAdapters under each node of the device.
        type: array
        items:
          $ref: '#/definitions/NodeNetwork'
        x-ms-identifiers: []
  DataBoxEdgeDeviceExtendedInfoPatch:
    description: The Data Box Edge/Gateway device extended info patch.
    type: object
    properties:
      clientSecretStoreId:
        description: The Key Vault ARM Id for client secrets
        type: string
      clientSecretStoreUrl:
        description: The url to access the Client Key Vault
        type: string
      channelIntegrityKeyName:
        description: The name for Channel Integrity Key stored in the Client Key Vault
        type: string
      channelIntegrityKeyVersion:
        description: The version of Channel Integrity Key stored in the Client Key Vault
        type: string
      syncStatus:
        description: For changing or to initiate the resync to key-vault set the status to KeyVaultSyncPending, rest of the status will not be applicable.
        enum:
        - KeyVaultSynced
        - KeyVaultSyncFailed
        - KeyVaultNotConfigured
        - KeyVaultSyncPending
        - KeyVaultSyncing
        - KeyVaultNotSynced
        type: string
        x-ms-enum:
          name: KeyVaultSyncStatus
          modelAsString: true
  DeviceRelationship:
    type: object
    description: An object representing the relationship between an upstream and a downstream device.
    properties:
      id:
        description: The unique identifier of this relationship.
        type: string
        readOnly: true
      source:
        description: The device ID of the source (parent) device.
        type: string
      target:
        description: The device ID of the target (child) device.
        type: string
  Device:
    description: Device API model.
    type: object
    properties:
      deviceDataModelId:
        description: Id of the associated device data model.
        type: string
      integrationId:
        description: Integration id for the device.
        type: string
      type:
        description: Type of device.
        maxLength: 100
        minLength: 0
        type: string
      hardwareId:
        description: Device hardwareId.
        maxLength: 100
        minLength: 0
        type: string
      reportingIntervalInSeconds:
        format: int32
        description: Interval at which the device sends data in seconds.
        type: integer
      parentDeviceId:
        description: Parent device Id for this device.
        type: string
      location:
        $ref: '#/definitions/Location'
      sensorPartnerId:
        description: Id of the associated sensor partner.
        type: string
        readOnly: true
      id:
        description: Id of the resource.
        type: string
        readOnly: true
      status:
        description: Status of the resource.
        maxLength: 100
        minLength: 0
        type: string
      createdDateTime:
        format: date-time
        description: 'Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
      modifiedDateTime:
        format: date-time
        description: 'Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
      eTag:
        description: The ETag value to implement optimistic concurrency.
        type: string
        readOnly: true
      name:
        description: Name to identify resource.
        maxLength: 100
        minLength: 0
        type: string
      description:
        description: Textual description of the resource.
        maxLength: 500
        minLength: 0
        type: string
      createdBy:
        description: Created by user/tenant id.
        type: string
        readOnly: true
      modifiedBy:
        description: Modified by user/tenant id.
        type: string
        readOnly: true
      properties:
        description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported."
        type: object
        additionalProperties: {}
        example:
          key1: value1
          key2: 123.45
  Device_5:
    description: Represents a StorSimple device object along with its properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel_2'
    properties:
      properties:
        $ref: '#/definitions/DeviceProperties_4'
        description: Collection of properties for the device
        x-ms-client-flatten: true
  Secret:
    description: Holds device secret either as a KeyVault reference or as an encrypted value.
    type: object
    properties:
      encryptedSecret:
        $ref: '#/definitions/AsymmetricEncryptedSecret'
        description: Encrypted (using device public key) secret value.
      keyVaultId:
        description: 'Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).'
        type: string
  DeviceProperties_4:
    description: Encases all the properties of the Device
    type: object
    properties:
      activationTime:
        format: date-time
        description: The UTC time at which the device was activated
        type: string
      allowedDeviceOperations:
        description: Operations that are allowed on the device based on its current state
        type: array
        items:
          enum:
          - None
          - Delete
          - DeleteWithWarning
          - DRSource
          - DRTarget
          - Browsable
          - ReadOnlyForDR
          - Deactivate
          type: string
          x-ms-enum:
            name: DeviceOperation
            modelAsString: false
      culture:
        description: 'Language culture setting on the device. For eg: "en-US"'
        type: string
      deviceCapabilities:
        description: Device can be configured either as FileServer or IscsiServer
        type: array
        items:
          enum:
          - Invalid
          - FileServer
          - IscsiServer
          type: string
          x-ms-enum:
            name: SupportedDeviceCapabilities
            modelAsString: false
      deviceDescription:
        description: Short description given for the device
        type: string
      domainName:
        description: Fully qualified name of the domain to which the device is attached
        type: string
      deviceSoftwareVersion:
        description: Version number of the software running on the device
        type: string
      friendlySoftwareName:
        description: Friendly name for the software version
        type: string
      deviceConfigurationStatus:
        description: '"Complete" if the device has been successfully registered as File/IscsiServer and the creation of share/volume is complete, "Pending" if the device is only registered but the creation of share/volume is complete is still pending'
        enum:
        - Complete
        - Pending
        type: string
        x-ms-enum:
          name: DeviceConfigurationStatus
          modelAsString: false
      modelDescription:
        description: Name of the device model
        type: string
      status:
        description: Current status of the device
        enum:
        - Unknown
        - Online
        - Offline
        - RequiresAttention
        - MaintenanceMode
        - Creating
        - Provisioning
        - Deleted
        - ReadyToSetup
        - Deactivated
        - Deactivating
        type: string
        x-ms-enum:
          name: DeviceStatus
          modelAsString: false
      type:
        description: Type of the device
        enum:
        - Invalid
        - Appliance
        - VirtualAppliance
        - Series9000OnPremVirtualAppliance
        - Series9000VirtualAppliance
        - Series9000PhysicalAppliance
        type: string
        x-ms-enum:
          name: DeviceType
          modelAsString: false
      details:
        $ref: '#/definitions/DeviceDetails_2'
        description: subclass containing more storage-related information about the device. This field will be populated only if the get call is made with $expand = details.
  UpdateSummaryProperties:
    description: The device update information summary.
    type: object
    properties:
      deviceVersionNumber:
        description: 'The current version of the device in format: 1.2.17312.13.",'
        type: string
      friendlyDeviceVersionName:
        description: The current version of the device in text format.
        type: string
      deviceLastScannedDateTime:
        format: date-time
        description: The last time when a scan was done on the device.
        type: string
      lastCompletedScanJobDateTime:
        format: date-time
        description: The time when the last scan job was completed (success/cancelled/failed) on the appliance.
        type: string
      lastSuccessfulScanJobTime:
        format: date-time
        description: Time when the last scan job is successfully completed.
        type: string
      lastCompletedDownloadJobDateTime:
        format: date-time
        description: The time when the last Download job was completed (success/cancelled/failed) on the appliance.
        type: string
        readOnly: true
      lastCompletedDownloadJobId:
        description: JobId of the last ran download job.(Can be success/cancelled/failed)
        type: string
        readOnly: true
      lastDownloadJobStatus:
        description: JobStatus of the last ran download job.
        enum:
        - Invalid
        - Running
        - Succeeded
        - Failed
        - Canceled
        - Paused
        - Scheduled
        type: string
        readOnly: true
        x-ms-enum:
          name: JobStatus
          modelAsString: true
      lastSuccessfulInstallJobDateTime:
        format: date-time
        description: The time when the Last Install job was completed successfully on the appliance
        type: string
      lastCompletedInstallJobDateTime:
        format: date-time
        description: The time when the last Install job was completed (success/cancelled/failed) on the appliance.
        type: string
        readOnly: true
      lastCompletedInstallJobId:
        description: JobId of the last ran install job.(Can be success/cancelled/failed)
        type: string
        readOnly: true
      lastInstallJobStatus:
        description: JobStatus of the last ran install job.
        enum:
        - Invalid
        - Running
        - Succeeded
        - Failed
        - Canceled
        - Paused
        - Scheduled
        type: string
        readOnly: true
        x-ms-enum:
          name: JobStatus
          modelAsString: true
      totalNumberOfUpdatesAvailable:
        format: int32
        description: The number of updates available for the current device version as per the last device scan.
        type: integer
        readOnly: true
      totalNumberOfUpdatesPendingDownload:
        format: int32
        description: The total number of items pending download.
        type: integer
        readOnly: true
      totalNumberOfUpdatesPendingInstall:
        format: int32
        description: The total number of items pending install.
        type: integer
        readOnly: true
      rebootBehavior:
        description: Indicates if updates are available and at least one of the updates needs a reboot.
        enum:
        - NeverReboots
        - RequiresReboot
        - RequestReboot
        type: string
        readOnly: true
        x-ms-enum:
          name: InstallRebootBehavior
          modelAsString: true
      ongoingUpdateOperation:
        description: The current update operation.
        enum:
        - None
        - Scan
        - Download
        - Install
        type: string
        readOnly: true
        x-ms-enum:
          name: UpdateOperation
          modelAsString: true
      inProgressDownloadJobId:
        description: The job ID of the download job in progress.
        type: string
        readOnly: true
      inProgressInstallJobId:
        description: The job ID of the install job in progress.
        type: string
        readOnly: true
      inProgressDownloadJobStartedDateTime:
        format: date-time
        description: The time when the currently running download (if any) started.
        type: string
        readOnly: true
      inProgressInstallJobStartedDateTime:
        format: date-time
        description: The time when the currently running install (if any) started.
        type: string
        readOnly: true
      updateTitles:
        description: The list of updates available for install.
        uniqueItems: false
        type: array
        items:
          type: string
        readOnly: true
      updates:
        description: The list of updates available for install.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/UpdateDetails'
        x-ms-identifiers:
        - updateTitle
        readOnly: true
      totalUpdateSizeInBytes:
        format: double
        description: The total size of updates available for download in bytes.
        type: number
        readOnly: true
      totalTimeInMinutes:
        format: int32
        description: The total time in Minutes
        type: integer
        readOnly: true
  Error_3:
    required:
    - errorCode
    - message
    type: object
    properties:
      errorCode:
        type: string
      message:
        $ref: '#/definitions/Message'
      values:
        type: array
        items:
          $ref: '#/definitions/Item'
        x-ms-identifiers:
        - key
  DataResidency:
    description: Wraps data-residency related information for edge-resource and this should be used with ARM layer.
    type: object
    properties:
      type:
        description: DataResidencyType enum
        enum:
        - GeoZoneReplication
        - ZoneReplication
        type: string
        x-ms-enum:
          name: DataResidencyType
          modelAsString: true
  UpdateSummary:
    description: Details about ongoing updates and availability of updates on the device.
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      properties:
        $ref: '#/definitions/UpdateSummaryProperties'
        description: The device update information summary.
        x-ms-client-flatten: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of UpdateSummary
        readOnly: true
  Error:
    description: An error from the Azure AgPlatform service.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Server-defined set of error codes.
        minLength: 1
        type: string
      message:
        description: Human-readable representation of the error.
        minLength: 1
        type: string
      target:
        description: Target of the error.
        type: string
      details:
        description: Array of details about specific errors that led to this reported error.
        type: array
        items:
          $ref: '#/definitions/Error'
      innererror:
        $ref: '#/definitions/InnerError'
  NetworkAdapterPosition:
    description: The network adapter position.
    type: object
    properties:
      networkGroup:
        description: The network group.
        enum:
        - None
        - NonRDMA
        - RDMA
        type: string
        readOnly: true
        x-ms-enum:
          name: NetworkGroup
          modelAsString: true
      port:
        format: int32
        description: The port.
        type: integer
        readOnly: true
  DeviceList:
    description: The collection of devices.
    required:
    - value
    type: object
    properties:
      value:
        description: The value.
        type: array
        items:
          $ref: '#/definitions/Device_4'
  BaseModel_2:
    description: Base class for models
    type: object
    properties:
      id:
        description: The identifier.
        type: string
        readOnly: true
      name:
        description: The name.
        type: string
        readOnly: true
      type:
        description: The type.
        type: string
        readOnly: true
  DevicePatchProperties:
    description: The properties of the device patch.
    type: object
    properties:
      deviceDescription:
        description: Short description given for the device
        type: string
  DeviceTelemetry:
    description: The device telemetry definition.
    type: object
    properties:
      value:
        description: The last known value of this device telemetry.
      timestamp:
        description: String-formatted date representing the time when the telemetry value was sent.
        type: string
        format: date-time
  SubscriptionRegisteredFeatures:
    type: object
    properties:
      name:
        type: string
      state:
        type: string
  DataBoxEdgeDeviceList:
    description: The collection of Data Box Edge/Gateway devices.
    type: object
    properties:
      value:
        description: The list of Data Box Edge/Gateway devices.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/DataBoxEdgeDevice'
        x-ms-identifiers: []
        readOnly: true
      nextLink:
        description: Link to the next set of results.
        type: string
        readOnly: true
  Location:
    description: Location model class.
    required:
    - latitude
    - longitude
    type: object
    properties:
      latitude:
        format: double
        description: Latitude of the location.
        maximum: 90
        minimum: -90
        type: number
      longitude:
        format: double
        description: Longitude of the location.
        maximum: 180
        minimum: -180
        type: number
  Ipv6Config:
    description: Details related to the IPv6 address configuration.
    type: object
    properties:
      ipAddress:
        description: The IPv6 address of the network adapter.
        type: string
        readOnly: true
      prefixLength:
        format: int32
        description: The IPv6 prefix of the network adapter.
        type: integer
        readOnly: true
      gateway:
        description: The IPv6 gateway of the network adapter.
        type: string
        readOnly: true
  MetricDefinitionList:
    description: The list of metric definitions.
    type: object
    properties:
      value:
        description: The list of metric definitions.
        type: array
        items:
          $ref: '#/definitions/MetricDefinition'
        x-ms-identifiers:
        - unit
        - /name/value
  ErrorDetails:
    description: The detail information of the error.
    type: object
    properties:
      code:
        type: string
        description: Error code.
      message:
        type: string
        description: Error message details.
      requestId:
        type: string
        description: Correlation Id for current request.
      time:
        type: string
        format: date-time-rfc1123
        description: The time that error request failed.
    required:
    - code
    - message
  FailoverSetEligibilityResult:
    description: The eligibility result of failover set, for failover.
    type: object
    properties:
      isEligibleForFailover:
        description: Represents if this failover set is eligible for failover or not.
        type: boolean
      errorMessage:
        description: The error message, if the failover set is not eligible for failover.
        type: string
  NetworkSettings:
    description: The network settings of a device.
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      properties:
        $ref: '#/definitions/NetworkSettingsProperties'
        description: The properties of network settings of a device.
        readOnly: true
        x-ms-client-flatten: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of NetworkSettings
        readOnly: true
  CloudErrorBody:
    description: An error response from the service.
    type: object
    properties:
      code:
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
        type: string
      message:
        description: A message describing the error, intended to be suitable for display in a user interface.
        type: string
      details:
        description: A list of additional details about the error.
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        x-ms-identifiers: []
    x-ms-external: true
  IPConfig:
    description: Details related to the IP address configuration
    required:
    - ipAddress
    - gateway
    type: object
    properties:
      ipAddress:
        description: The IP address of the network adapter, either ipv4 or ipv6.
        type: string
      prefixLength:
        format: int32
        description: The prefix length of the network adapter.
        type: integer
      gateway:
        description: The gateway of the network adapter.
        type: string
  DeviceProperties_2:
    type: object
    description: The properties of device
    properties:
      deviceId:
        type: string
        description: Device ID
        x-ms-mutability:
        - read
        - create
      chipSku:
        type: string
        description: SKU of the chip
        readOnly: true
      lastAvailableOsVersion:
        type: string
        description: OS version available for installation when update requested
        readOnly: true
      lastInstalledOsVersion:
        type: string
        description: OS version running on device when update requested
        readOnly: true
      lastOsUpdateUtc:
        type: string
        format: date-time
        description: Time when update requested and new OS version available
        readOnly: true
      lastUpdateRequestUtc:
        type: string
        format: date-time
        description: Time when update was last requested
        readOnly: true
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
  X509CertificateInfo:
    description: The X509 certificate info.
    type: object
    properties:
      sha1Thumbprint:
        description: The SHA-1 hash value of the certificate.
        type: string
    required:
    - sha1Thumbprint
  DeviceUpdateProperties:
    type: object
    description: The updatable properties of the Device.
    properties:
      deviceGroupId:
        type: string
        description: Device group id
  SecuritySettings:
    description: The security settings of a device.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      properties:
        $ref: '#/definitions/SecuritySettingsProperties'
        description: Properties of the security settings.
        x-ms-client-flatten: true
  ResourceIdentity:
    description: Msi identity details of the resource
    type: object
    properties:
      type:
        description: Identity type
        enum:
        - None
        - SystemAssigned
        - UserAssigned
        type: string
        x-ms-enum:
          name: MsiIdentityType
          modelAsString: true
      principalId:
        description: Service Principal Id backing the Msi
        type: string
        readOnly: true
      tenantId:
        description: Home Tenant Id
        type: string
        readOnly: true
  AlertSettings:
    description: AlertSettings on the device which represents how alerts will be processed
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel_2'
    properties:
      properties:
        $ref: '#/definitions/AlertSettingsProperties'
        description: Properties of AlertSettings
        x-ms-client-flatten: true
  DataBoxEdgeDeviceExtendedInfoProperties:
    description: The properties of the Data Box Edge/Gateway device extended info.
    type: object
    properties:
      encryptionKeyThumbprint:
        description: The digital signature of encrypted certificate.
        type: string
      encryptionKey:
        description: The public part of the encryption certificate. Client uses this to encrypt any secret.
        type: string
      resourceKey:
        description: The Resource ID of the Resource.
        type: string
        readOnly: true
      clientSecretStoreId:
        description: The Key Vault ARM Id for client secrets
        type: string
      clientSecretStoreUrl:
        description: The url to access the Client Key Vault
        type: string
      channelIntegrityKeyName:
        description: The name of Channel Integrity Key stored in the Client Key Vault
        type: string
      channelIntegrityKeyVersion:
        description: The version of Channel Integrity Key stored in the Client Key Vault
        type: string
      keyVaultSyncStatus:
        description: Key vault sync status
        enum:
        - KeyVaultSynced
        - KeyVaultSyncFailed
        - KeyVaultNotConfigured
        - KeyVaultSyncPending
        - KeyVaultSyncing
        - KeyVaultNotSynced
        type: string
        x-ms-enum:
          name: KeyVaultSyncStatus
          modelAsString: true
      deviceSecrets:
        description: Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
        type: object
        additionalProperties:
          $ref: '#/definitions/Secret'
        readOnly: true
      clusterWitnessType:
        description: Cluster Witness Type
        enum:
        - None
        - Cloud
        - FileShare
        type: string
        readOnly: true
        x-ms-enum:
          name: ClusterWitnessType
          modelAsString: true
      fileShareWitnessLocation:
        description: The witness location of file share.
        type: string
        readOnly: true
      fileShareWitnessUsername:
        description: The username of file share.
        type: string
        readOnly: true
      cloudWitnessStorageAccountName:
        description: The Cloud Witness Storage account name.
        type: string
        readOnly: true
      cloudWitnessContainerName:
        description: The Container for cloud witness in the storage account.
        type: string
        readOnly: true
      cloudWitnessStorageEndpoint:
        description: The Azure service endpoint of the cloud witness storage account.
        type: string
        readOnly: true
  FailoverTarget:
    description: Represents the eligibility of a device as a failover target device.
    type: object
    properties:
      deviceId:
        description: The path ID of the device.
        type: string
      deviceStatus:
        description: The status of the device.
        enum:
        - Unknown
        - Online
        - Offline
        - Deactivated
        - RequiresAttention
        - MaintenanceMode
        - Creating
        - Provisioning
        - Deactivating
        - Deleted
        - ReadyToSetup
        type: string
        x-ms-enum:
          name: DeviceStatus
          modelAsString: false
      modelDescription:
        description: The model number of the device.
        type: string
      deviceSoftwareVersion:
        description: The software version of the device.
        type: string
      dataContainersCount:
        format: int32
        description: The count of data containers on the device.
        type: integer
      volumesCount:
        format: int32
        description: The count of volumes on the device.
        type: integer
      availableLocalStorageInBytes:
        format: int64
        description: The amount of free local storage available on the device in bytes.
        type: integer
      availableTieredStorageInBytes:
        format: int64
        description: The amount of free tiered storage available for the device in bytes.
        type: integer
      deviceLocation:
        description: The geo location (applicable only for cloud appliances) of the device.
        type: string
      friendlyDeviceSoftwareVersion:
        description: The friendly name for the current version of software on the device.
        type: string
      eligibilityResult:
        $ref: '#/definitions/TargetEligibilityResult'
        description: The eligibility result of the device, as a failover target device.
  NetworkSettings_2:
    description: The NetworkSettings of a device
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel_2'
    properties:
      properties:
        $ref: '#/definitions/NetworkSettingsProperties_2'
        description: Properties of the given NetworkSettings.
        x-ms-client-flatten: true
  DeploymentManifest:
    description: The deployment manifest used for edge devices.
    type: object
    properties:
      id:
        description: Unique ID of the deployment manifest.
        type: string
        readOnly: true
      displayName:
        description: Display name of the deployment manifest.
        type: string
        minLength: 1
      data:
        description: Content of the the deployment manifest.
        type: object
      etag:
        description: Etag to prevent conflict when updating the deployment manifest.
        type: string
      organizations:
        description: The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon.
        type: array
        items:
          type: string
        maxItems: 1
        minItems: 1
    required:
    - data
  Attestation:
    description: The attestation definition.
    type: object
    properties:
      type:
        description: Type of the attestation.
        type: string
    required:
    - type
    discriminator: type
  AsymmetricEncryptedSecret:
    description: Represent the secrets intended for encryption with asymmetric key pair.
    required:
    - value
    - encryptionAlgorithm
    type: object
    properties:
      value:
        description: The value of the secret.
        type: string
      encryptionCertThumbprint:
        description: Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null.
        x-ms-secret: true
        type: string
      encryptionAlgorithm:
        description: The algorithm used to encrypt "Value".
        enum:
        - None
        - AES256
        - RSAES_PKCS1_v_1_5
        type: string
        x-ms-enum:
          name: EncryptionAlgorithm
          modelAsString: true
  ErrorResponse:
    description: An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
    type: object
    properties:
      error:
        $ref: '#/definitions/Error'
      traceId:
        description: Unique trace Id.
        type: string
  DevicePatch:
    description: The device patch.
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/DevicePatchProperties'
        description: The properties of the device patch.
        x-ms-client-flatten: true
  ComputeVersionInformation:
    description: This contains the compute information
    type: object
    properties:
      kubernetesVersion:
        description: Kubernetes Version
        type: string
      iotEdgeVersion:
        description: IOTEdge Version
        type: string
      azureArcVersion:
        description: Azure Arc Version
        type: string
  DeviceList_2:
    description: Collection of Devices
    required:
    - value
    type: object
    properties:
      value:
        description: The value.
        type: array
        items:
          $ref: '#/definitions/Device_5'
  GenerateCertResponse:
    description: Used in activation key generation flow.
    type: object
    properties:
      publicKey:
        description: "Gets or sets base64 encoded certificate raw data,\r\nthis is the public part needed to be uploaded to cert vault"
        type: string
      privateKey:
        description: "Gets or sets base64 encoded private part of the certificate,\r\nneeded to form the activation key"
        type: string
        x-ms-secret: true
      expiryTimeInUTC:
        description: Gets or sets expiry time in UTC
        type: string
  Collection:
    description: The collection of entities.
    type: object
    properties:
      value:
        description: The collection of entities.
        type: array
        items:
          type: object
      nextLink:
        description: URL to get the next page of entities.
        type: string
    required:
    - value
  SymmetricKey:
    description: The symmetric key definition.
    type: object
    properties:
      primaryKey:
        description: The primary key for this credential.
        type: string
      secondaryKey:
        description: The secondary key for this credential.
        type: string
    required:
    - primaryKey
    - secondaryKey
  MetricDefinition:
    description: The monitoring metric definition.
    type: object
    properties:
      name:
        $ref: '#/definitions/MetricName'
        description: The metric name.
      unit:
        description: The metric unit.
        enum:
        - Bytes
        - BytesPerSecond
        - Count
        - CountPerSecond
        - Percent
        - Seconds
        type: string
        x-ms-enum:
          name: MetricUnit
          modelAsString: false
      primaryAggregationType:
        description: The metric aggregation type.
        enum:
        - Average
        - Last
        - Maximum
        - Minimum
        - None
        - Total
        type: string
        x-ms-enum:
          name: MetricAggregationType
          modelAsString: false
      resourceId:
        description: The metric source ID.
        type: string
      metricAvailabilities:
        description: The available metric granularities.
        type: array
        items:
          $ref: '#/definitions/MetricAvailablity'
        x-ms-identifiers:
        - timeGrain
      dimensions:
        description: The available metric dimensions.
        type: array
        items:
          $ref: '#/definitions/MetricDimension'
        x-ms-identifiers:
        - name
      category:
        description: The category of the metric.
        type: string
      type:
        description: The metric definition type.
        type: string
  DeviceListResponse:
    description: Paged response contains list of requested objects and a URL link to get the next set of results.
    required:
    - value
    type: object
    properties:
      value:
        description: List of requested objects.
        type: array
        items:
          $ref: '#/definitions/Device'
      skipToken:
        description: Token used in retrieving the next page. If null, there are no additional pages.
        type: string
      nextLink:
        description: Continuation link (absolute URI) to the next page of results in the list.
        type: string
  UploadCertificateRequest:
    description: The upload certificate request.
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/RawCertificateData'
        description: The Base 64 encoded certificate raw data.
        x-ms-client-flatten: true
  SubscriptionProperties:
    type: object
    properties:
      tenantId:
        type: string
      locationPlacementId:
        type: string
      quotaId:
        type: string
      serializedDetails:
        type: string
      registeredFeatures:
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/SubscriptionRegisteredFeatures'
        x-ms-identifiers:
        - name
  DataBoxEdgeDevicePropertiesPatch:
    description: The Data Box Edge/Gateway device properties patch.
    type: object
    properties:
      edgeProfile:
        $ref: '#/definitions/EdgeProfilePatch'
        description: Edge Profile property of the Data Box Edge/Gateway device
  ConfigureDeviceRequest:
    description: The mandatory device configuration request.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel'
    properties:
      properties:
        $ref: '#/definitions/ConfigureDeviceRequestProperties'
        description: The properties of the configure device request.
        x-ms-client-flatten: true
  DeviceRelationshipCollection:
    description: The paged results of device relationships.
    type: object
    properties:
      value:
        description: The collection of device relationships.
        type: array
        items:
          $ref: '#/definitions/DeviceRelationship'
      nextLink:
        description: URL to get the next page of device relationships.
        type: string
    required:
    - value
  FailoverSet:
    description: The failover set on a device.
    type: object
    properties:
      volumeContainers:
        description: The list of meta data of volume containers, which are part of the failover set.
        type: array
        items:
          $ref: '#/definitions/VolumeContainerFailoverMetadata'
        x-ms-identifiers:
        - volumeContainerId
      eligibilityResult:
        $ref: '#/definitions/FailoverSetEligibilityResult'
        description: The eligibility result of the failover set, for failover.
  Item:
    required:
    - key
    - value
    type: object
    properties:
      key:
        type: string
      value:
        type: string
  SecondaryDNSSettings:
    description: The secondary DNS settings.
    type: object
    properties:
      secondaryDnsServers:
        description: The list of secondary DNS Server IP addresses.
        type: array
        items:
          type: string
  MetricData:
    description: The metric data.
    type: object
    properties:
      timeStamp:
        format: date-time
        description: The time stamp of the metric data.
        type: string
      sum:
        format: double
        description: The sum of all samples at the time stamp.
        type: number
      count:
        format: int32
        description: The count of all samples at the time stamp.
        type: integer
      average:
        format: double
        description: The average of all samples at the time stamp.
        type: number
      minimum:
        format: double
        description: The minimum of all samples at the time stamp.
        type: number
      maximum:
        format: double
        description: The maximum of all samples at the time stamp.
        type: number
  Device_4:
    description: The StorSimple device.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel'
    properties:
      properties:
        $ref: '#/definitions/DeviceProperties_3'
        description: The properties of the StorSimple device.
        x-ms-client-flatten: true
  Message:
    type: object
    properties:
      language:
        type: string
      value:
        type: string
  SecuritySettingsProperties:
    description: The properties of security settings.
    required:
    - deviceAdminPassword
    type: object
    properties:
      deviceAdminPassword:
        $ref: '#/definitions/AsymmetricEncryptedSecret'
        description: 'Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the  local web UI of the device. The Actual password should have at least 8 characters that are a combination of  uppercase, lowercase, numeric, and special characters.'
  TimeSettingsProperties:
    description: The properties of TimeSettings
    required:
    - timeZone
    - primaryTimeServer
    type: object
    properties:
      timeZone:
        description: The timezone of device, like '(UTC -06:00) Central America'
        type: string
      primaryTimeServer:
        description: The primary Network Time Protocol (NTP) server name, like 'time.windows.com'.
        type: string
      secondaryTimeServer:
        description: The secondary Network Time Protocol (NTP) server name, like 'time.contoso.com'. It's optional.
        type: string
  EdgeProfileSubscription:
    description: Subscription details for the Edge Profile
    type: object
    properties:
      registrationId:
        description: Edge Subscription Registration ID
        type: string
      id:
        description: ARM ID of the subscription
        type: string
      state:
        enum:
        - Registered
        - Warned
        - Suspended
        - Deleted
        - Unregistered
        type: string
        x-ms-enum:
          name: SubscriptionState
          modelAsString: true
      registrationDate:
        type: string
      subscriptionId:
        type: string
      properties:
        $ref: '#/definitions/SubscriptionProperties'
        x-ms-client-flatten: true
  DeviceProperties_3:
    description: The properties of the StorSimple device.
    required:
    - friendlyName
    - activationTime
    - culture
    - deviceDescription
    - deviceSoftwareVersion
    - deviceConfigurationStatus
    - targetIqn
    - modelDescription
    - status
    - serialNumber
    - deviceType
    - activeController
    - friendlySoftwareVersion
    type: object
    properties:
      friendlyName:
        description: The friendly name of the device.
        type: string
      activationTime:
        format: date-time
        description: The UTC time at which the device was activated
        type: string
      culture:
        description: 'The language culture setting on the device. For eg: "en-US"'
        type: string
      deviceDescription:
        description: The device description.
        type: string
      deviceSoftwareVersion:
        description: The version number of the software running on the device.
        type: string
      friendlySoftwareName:
        description: The friendly name of the software running on the device.
        type: string
      deviceConfigurationStatus:
        description: The current configuration status of the device.
        enum:
        - Complete
        - Pending
        type: string
        x-ms-enum:
          name: DeviceConfigurationStatus
          modelAsString: false
      targetIqn:
        description: The target IQN.
        type: string
      modelDescription:
        description: The device model.
        type: string
      status:
        description: The current status of the device.
        enum:
        - Unknown
        - Online
        - Offline
        - Deactivated
        - RequiresAttention
        - MaintenanceMode
        - Creating
        - Provisioning
        - Deactivating
        - Deleted
        - ReadyToSetup
        type: string
        x-ms-enum:
          name: DeviceStatus
          modelAsString: false
      serialNumber:
        description: The serial number.
        type: string
      deviceType:
        description: The type of the device.
        enum:
        - Invalid
        - Series8000VirtualAppliance
        - Series8000PhysicalAppliance
        type: string
        x-ms-enum:
          name: DeviceType
          modelAsString: false
      activeController:
        description: The identifier of the active controller of the device.
        enum:
        - Unknown
        - None
        - Controller0
        - Controller1
        type: string
        x-ms-enum:
          name: ControllerId
          modelAsString: false
      friendlySoftwareVersion:
        description: The device friendly software version.
        type: string
      availableLocalStorageInBytes:
        format: int64
        description: The storage in bytes that is available locally on the device.
        type: integer
      availableTieredStorageInBytes:
        format: int64
        description: The storage in bytes that is available on the device for tiered volumes.
        type: integer
      provisionedTieredStorageInBytes:
        format: int64
        description: The storage in bytes that has been provisioned on the device for tiered volumes.
        type: integer
      provisionedLocalStorageInBytes:
        format: int64
        description: The storage in bytes used for locally pinned volumes on the device (including additional local reservation).
        type: integer
      provisionedVolumeSizeInBytes:
        format: int64
        description: Total capacity in bytes of tiered and locally pinned volumes on the device
        type: integer
      usingStorageInBytes:
        format: int64
        description: The storage in bytes that is currently being used on the device, including both local and cloud.
        type: integer
      totalTieredStorageInBytes:
        format: int64
        description: The total tiered storage available on the device in bytes.
        type: integer
      agentGroupVersion:
        format: int32
        description: The device agent group version.
        type: integer
      networkInterfaceCardCount:
        format: int32
        description: The number of network interface cards
        type: integer
      deviceLocation:
        description: The location of the virtual appliance.
        type: string
      virtualMachineApiType:
        description: The virtual machine API type.
        enum:
        - Classic
        - Arm
        type: string
        readOnly: true
        x-ms-enum:
          name: VirtualMachineApiType
          modelAsString: false
      details:
        $ref: '#/definitions/DeviceDetails'
        description: The additional device details regarding the end point count and volume container count.
      rolloverDetails:
        $ref: '#/definitions/DeviceRolloverDetails'
        description: The additional device details for the service data encryption key rollover.
  X509Certificate:
    description: The X509 certificate definition.
    type: object
    properties:
      certificate:
        description: The string representation of this certificate.
        type: string
      info:
        description: Information about this certificate.
        readOnly: true
        $ref: '#/definitions/X509CertificateInfo'
  EdgeProfileSubscriptionPatch:
    description: The Data Box Edge/Gateway Edge Profile Subscription patch.
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the subscription of the edge profile.
        type: string
  CapabilityType:
    type: string
    description: Capability image type
    enum:
    - ApplicationDevelopment
    - FieldServicing
    x-ms-enum:
      name: CapabilityType
      modelAsString: true
      values:
      - name: ApplicationDevelopment
        value: ApplicationDevelopment
        description: Application development capability
      - name: FieldServicing
        value: FieldServicing
        description: Field servicing capability
  Updates:
    description: The updates profile of a device.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel'
    properties:
      properties:
        $ref: '#/definitions/UpdatesProperties'
        description: The properties of the updates profile.
        x-ms-client-flatten: true
  TargetEligibilityErrorMessage:
    description: The error/warning message due to which the device is ineligible as a failover target device.
    type: object
    properties:
      message:
        description: The localized error message stating the reason why the device is not eligible as a target device.
        type: string
      resolution:
        description: The localized resolution message for the error.
        type: string
      resultCode:
        description: The result code for the error, due to which the device does not qualify as a failover target device.
        enum:
        - TargetAndSourceCannotBeSameError
        - TargetIsNotOnlineError
        - TargetSourceIncompatibleVersionError
        - LocalToTieredVolumesConversionWarning
        - TargetInsufficientCapacityError
        - TargetInsufficientLocalVolumeMemoryError
        - TargetInsufficientTieredVolumeMemoryError
        type: string
        x-ms-enum:
          name: TargetEligibilityResultCode
          modelAsString: false
  DeviceCollection:
    description: The paged results of devices.
    type: object
    properties:
      value:
        description: The collection of devices.
        type: array
        items:
          $ref: '#/definitions/Device_2'
      nextLink:
        description: URL to get the next page of devices.
        type: string
    required:
    - value
  UpdatesProperties:
    description: The properties of the updates profile.
    type: object
    properties:
      regularUpdatesAvailable:
        description: Set to 'true' if regular updates are available for the device.
        type: boolean
      maintenanceModeUpdatesAvailable:
        description: Set to 'true' if maintenance mode update available.
        type: boolean
      isUpdateInProgress:
        description: Indicates whether an update is in progress or not.
        type: boolean
      lastUpdatedTime:
        format: date-time
        description: The time when the last update was completed.
        type: string
  DataBoxEdgeDevicePatch:
    description: The Data Box Edge/Gateway device patch.
    type: object
    properties:
      tags:
        description: The tags attached to the Data Box Edge/Gateway resource.
        type: object
        additionalProperties:
          type: string
      identity:
        $ref: '#/definitions/ResourceIdentity'
        description: Msi identity of the resource
      properties:
        $ref: '#/definitions/DataBoxEdgeDevicePropertiesPatch'
        description: The properties associated with the Data Box Edge/Gateway resource
        x-ms-client-flatten: true
  DataBoxEdgeDeviceExtendedInfo:
    description: The extended Info of the Data Box Edge/Gateway device.
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      properties:
        $ref: '#/definitions/DataBoxEdgeDeviceExtendedInfoProperties'
        description: The extended info properties.
        x-ms-client-flatten: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of DataBoxEdgeDevice
        readOnly: true
  ListFailoverTargetsRequest:
    description: The request object for fetching the list of failover targets (eligible devices for failover).
    type: object
    properties:
      volumeContainers:
        description: The list of path IDs of the volume containers that needs to be failed-over, for which we want to fetch the eligible targets.
        type: array
        items:
          type: string
  GenerateCapabilityImageRequest:
    type: object
    description: Request of the action to create a signed device capability image
    properties:
      capabilities:
        type: array
        description: List of capabilities to create
        items:
          $ref: '#/definitions/CapabilityType'
    required:
    - capabilities
  EdgeProfile:
    description: Details about Edge Profile for the resource
    type: object
    properties:
      subscription:
        $ref: '#/definitions/EdgeProfileSubscription'
        description: Edge Profile Subscription
  DeviceDetails_2:
    description: Class containing more granular details about the device
    type: object
    properties:
      endpointCount:
        format: int32
        description: Total number of endpoints that are currently on the device ( i.e. number of shares on FileServer or number of volumes on IscsiServer)
        type: integer
      totalStorageInBytes:
        format: int64
        description: Total storage available on the device in bytes.
        type: integer
      totalLocalStorageInBytes:
        format: int64
        description: Total local storage capacity in device in bytes.
        type: integer
      provisionedStorageInBytes:
        format: int64
        description: Storage in bytes that has been provisioned on the device including both local and cloud
        type: integer
      provisionedLocalStorageInBytes:
        format: int64
        description: Storage in bytes that has been provisioned locally on the device
        type: integer
      usingStorageInBytes:
        format: int64
        description: Storage that is being currently used in bytes including both local and cloud
        type: integer
      usingLocalStorageInBytes:
        format: int64
        description: Local Storage that is being currently used in bytes
        type: integer
      totalBackupSizeInBytes:
        format: int64
        description: Total size taken up by backups in bytes
        type: integer
      availableStorageInBytes:
        format: int64
        description: Total pending available storage on the device in bytes
        type: integer
      availableLocalStorageInBytes:
        format: int64
        description: Local pending storage available on the device in bytes
        type: integer
  Sku:
    description: The SKU type.
    type: object
    properties:
      name:
        description: SKU name.
        enum:
        - Gateway
        - Edge
        - TEA_1Node
        - TEA_1Node_UPS
        - TEA_1Node_Heater
        - TEA_1Node_UPS_Heater
        - TEA_4Node_Heater
        - TEA_4Node_UPS_Heater
        - TMA
        - TDC
        - TCA_Small
        - GPU
        - TCA_Large
        - EdgeP_Base
        - EdgeP_High
        - EdgePR_Base
        - EdgePR_Base_UPS
        - EP2_64_1VPU_W
        - EP2_128_1T4_Mx1_W
        - EP2_256_2T4_W
        - EdgeMR_Mini
        - RCA_Small
        - RCA_Large
        - RDC
        - Management
        - EP2_64_Mx1_W
        - EP2_128_GPU1_Mx1_W
        - EP2_256_GPU2_Mx1
        - EdgeMR_TCP
        type: string
        x-ms-enum:
          name: SkuName
          modelAsString: true
      tier:
        description: The SKU tier. This is based on the SKU name.
        enum:
        - Standard
        type: string
        x-ms-enum:
          name: SkuTier
          modelAsString: true
  Device_2:
    description: The device definition.
    type: object
    properties:
      id:
        description: Unique ID of the device.
        type: string
        readOnly: true
      etag:
        description: ETag used to prevent conflict in device updates.
        type: string
      displayName:
        description: Display name of the device.
        type: string
      template:
        description: The device template definition for the device.
        type: string
      enabled:
        description: Whether the device connection to IoT Central has been enabled.
        type: boolean
      provisioned:
        description: Whether resources have been allocated for the device.
        type: boolean
        readOnly: true
      simulated:
        description: Whether the device is simulated.
        type: boolean
      organizations:
        description: List of organization IDs that the device is a part of, only one organization is supported today, multiple organizations will be supported soon.
        type: array
        items:
          type: string
      type:
        description: The type of the device.
        type: array
        items:
          type: string
          enum:
          - iotEdge
          x-ms-enum:
            name: DeviceType
            modelAsString: true
            values:
            - value: iotEdge
              name: IotEdge
              description: The edge device type
      deploymentManifest:
        description: The deployment manifest assigned to the device.
        $ref: '#/definitions/DeploymentManifest'
  NetworkAdapter_2:
    description: Represents a networkAdapter in a particular node.
    required:
    - networkAdapterName
    - dhcpStatus
    type: object
    properties:
      networkAdapterName:
        description: The name of the network adapter.
        type: string
      iPv4Info:
        $ref: '#/definitions/IPConfig'
        description: The ipv4 configuration of the network adapter.
      iPv6Info:
        $ref: '#/definitions/IPConfig'
        description: The ipv6 configuration of the network adapter.
      dhcpStatus:
        description: Represents state of DHCP.
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: DhcpStatus
          modelAsString: false
      linkSpeed:
        format: int64
        description: The speed of the network adapter.
        type: integer
  DataBoxEdgeDeviceProperties:
    description: The properties of the Data Box Edge/Gateway device.
    type: object
    properties:
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: DataBoxEdge Device Properties
        readOnly: true
      dataBoxEdgeDeviceStatus:
        description: The status of the Data Box Edge/Gateway device.
        enum:
        - ReadyToSetup
        - Online
        - Offline
        - NeedsAttention
        - Disconnected
        - PartiallyDisconnected
        - Maintenance
        type: string
        readOnly: true
        x-ms-enum:
          name: DataBoxEdgeDeviceStatus
          modelAsString: true
      serialNumber:
        description: The Serial Number of Data Box Edge/Gateway device.
        type: string
        readOnly: true
      description:
        description: The Description of the Data Box Edge/Gateway device.
        type: string
        readOnly: true
      modelDescription:
        description: The description of the Data Box Edge/Gateway device model.
        type: string
        readOnly: true
      deviceType:
        description: The type of the Data Box Edge/Gateway device.
        enum:
        - DataBoxEdgeDevice
        type: string
        readOnly: true
        x-ms-enum:
          name: DeviceType
          modelAsString: true
      friendlyName:
        description: The Data Box Edge/Gateway device name.
        type: string
        readOnly: true
      culture:
        description: The Data Box Edge/Gateway device culture.
        type: string
        readOnly: true
      deviceModel:
        description: The Data Box Edge/Gateway device model.
        type: string
        readOnly: true
      deviceSoftwareVersion:
        description: The Data Box Edge/Gateway device software version.
        type: string
        readOnly: true
      deviceLocalCapacity:
        format: int64
        description: The Data Box Edge/Gateway device local capacity in MB.
        type: integer
        readOnly: true
      timeZone:
        description: The Data Box Edge/Gateway device timezone.
        type: string
        readOnly: true
      deviceHcsVersion:
        description: 'The device software version number of the device (eg: 1.2.18105.6).'
        type: string
        readOnly: true
      configuredRoleTypes:
        description: Type of compute roles configured.
        uniqueItems: false
        type: array
        items:
          enum:
          - IOT
          - ASA
          - Functions
          - Cognitive
          - MEC
          - CloudEdgeManagement
          - Kubernetes
          type: string
          x-ms-enum:
            name: RoleTypes
            modelAsString: true
          x-ms-identifiers: []
        readOnly: true
      nodeCount:
        format: int32
        description: The number of nodes in the cluster.
        type: integer
        readOnly: true
      resourceMoveDetails:
        $ref: '#/definitions/ResourceMoveDetails'
        description: The details of the move operation on this resource.
        readOnly: true
      edgeProfile:
        $ref: '#/definitions/EdgeProfile'
        description: The details of Edge Profile for this resource
        readOnly: true
      dataResidency:
        $ref: '#/definitions/DataResidency'
        description: The details of data-residency related properties for this resource
      computeVersionInformation:
        $ref: '#/definitions/ComputeVersionInformation'
        description: The details of compute version information
        readOnly: true
      kubernetesPlatform:
        description: Type of Kubernetes Platform
        type: string
        readOnly: true
  DeviceCommand:
    description: The device command definition.
    type: object
    properties:
      id:
        description: The request ID of the device command execution.
        type: string
        readOnly: true
      connectionTimeout:
        description: Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds.
        type: integer
        format: int32
        minimum: 0
        maximum: 30
      responseTimeout:
        description: Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds.
        type: integer
        format: int32
        minimum: 5
        maximum: 30
      request:
        description: The payload for the device command, support any primitive types or object.
      response:
        description: The payload of the device command response, support any primitive types or object.
        readOnly: true
      responseCode:
        description: The status code of the device command response.
        type: integer
        format: int32
        readOnly: true
  FailoverSetsList:
    description: The list of failover sets.
    type: object
    properties:
      value:
        description: The list of failover sets.
        type: array
        items:
          $ref: '#/definitions/FailoverSet'
        x-ms-identifiers: []
  FailoverRequest_2:
    description: The Failover request object.
    type: object
    properties:
      accesspointIds:
        type: array
        items:
          type: string
      targetDeviceId:
        type: string
      skipValidation:
        type: boolean
      keepSourceDevice:
        type: boolean
  Device_3:
    type: object
    description: An device resource belonging to a device group resource.
    properties:
      properties:
        $ref: '#/definitions/DeviceProperties_2'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
  DeviceUpdate:
    type: object
    description: The type used for update operations of the Device.
    properties:
      properties:
        $ref: '#/definitions/DeviceUpdateProperties'
        x-ms-client-flatten: true
  ARMBaseModel:
    description: Represents the base class for all object models.
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the object.
        type: string
        readOnly: true
      name:
        description: The object name.
        type: string
        readOnly: true
      type:
        description: The hierarchical type of the object.
        type: string
        readOnly: true
    x-ms-azure-resource: true
  ConfigureDeviceRequestProperties:
    description: The properties of the configure device request.
    required:
    - friendlyName
    - currentDeviceName
    - timeZone
    type: object
    properties:
      friendlyName:
        description: The friendly name for the device.
        type: string
      currentDeviceName:
        description: The current name of the device.
        type: string
      timeZone:
        description: 'The device time zone. For eg: "Pacific Standard Time"'
        type: string
      dnsSettings:
        $ref: '#/definitions/SecondaryDNSSettings'
        description: The secondary DNS Settings of the device.
      networkInterfaceData0Settings:
        $ref: '#/definitions/NetworkInterfaceData0Settings'
        description: The 'Data 0' network interface card settings.
  RawCertificateData:
    description: Raw Certificate Data.
    required:
    - certificate
    type: object
    properties:
      authenticationType:
        description: The authentication type.
        enum:
        - Invalid
        - AzureActiveDirectory
        type: string
        x-ms-enum:
          name: AuthenticationType
          modelAsString: true
      certificate:
        description: The base64 encoded certificate raw data.
        type: string
  MetricList:
    description: The metric list.
    type: object
    properties:
      value:
        description: The value.
        type: array
        items:
          $ref: '#/definitions/Metrics'
        x-ms-identifiers: []
  MetricAvailablity:
    description: The metric availability.
    type: object
    properties:
      timeGrain:
        description: The aggregation interval for the metric.
        type: string
      retention:
        description: The retention period for the metric at the specified timegrain.
        type: string
  NetworkSettingsProperties:
    description: The properties of network settings.
    type: object
    properties:
      networkAdapters:
        description: The network adapter list on the device.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/NetworkAdapter'
        x-ms-identifiers:
        - adapterId
        readOnly: true
  FailoverTargetsList:
    description: The list of all devices in a resource and their eligibility status as a failover target device.
    type: object
    properties:
      value:
        description: The list of all the failover targets.
        type: array
        items:
          $ref: '#/definitions/FailoverTarget'
        x-ms-identifiers:
        - deviceId
  UpdateDetails:
    description: Update Specific attributes
    type: object
    properties:
      updateTitle:
        description: Title of the Update
        type: string
      updateSize:
        format: double
        description: Size of the update(In Bytes)
        type: number
      updateType:
        description: Type of the Update
        enum:
        - Software
        - Kubernetes
        - Firmware
        type: string
        x-ms-enum:
          name: UpdateType
          modelAsString: true
      targetVersion:
        description: Target Version number
        type: string
      friendlyVersionNumber:
        description: Friendly Version Number
        type: string
      estimatedInstallTimeInMins:
        format: int32
        description: Estimated Install Time for the update
        type: integer
      rebootBehavior:
        description: Indicates if updates are available and at least one of the updates needs a reboot.
        enum:
        - NeverReboots
        - RequiresReboot
        - RequestReboot
        type: string
        x-ms-enum:
          name: InstallRebootBehavior
          modelAsString: true
      installationImpact:
        description: Impact of Installing an updateType
        enum:
        - None
        - DeviceRebooted
        - KubernetesWorkloadsDown
        type: string
        x-ms-enum:
          name: InstallationImpact
          modelAsString: true
      status:
        description: Status of the update.
        enum:
        - DownloadPending
        - DownloadStarted
        - DownloadCompleted
        - InstallStarted
        - InstallCompleted
        type: string
        x-ms-enum:
          name: UpdateStatus
          modelAsString: true
  Tpm:
    description: The trusted platform module definition.
    type: object
    properties:
      endorsementKey:
        description: The TPM endorsement key for this credential.
        type: string
    required:
    - endorsementKey
  ResourceMoveDetails:
    description: Fields for tracking resource move
    type: object
    properties:
      operationInProgress:
        description: Denotes whether move operation is in progress
        enum:
        - None
        - ResourceMoveInProgress
        - ResourceMoveFailed
        type: string
        x-ms-enum:
          name: ResourceMoveStatus
          modelAsString: true
      operationInProgressLockTimeoutInUTC:
        format: date-time
        description: Denotes the timeout of the operation to finish
        type: string
  MetricName:
    description: The metric name.
    type: object
    properties:
      value:
        description: The metric name.
        type: string
      localizedValue:
        description: The localized metric name.
        type: string
  DataBoxEdgeDevice:
    description: The Data Box Edge/Gateway device.
    required:
    - location
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      location:
        description: The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.
        type: string
        x-ms-mutability:
        - read
        - create
      tags:
        description: The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).
        type: object
        additionalProperties:
          type: string
      sku:
        $ref: '#/definitions/Sku'
        description: The SKU type.
      etag:
        description: The etag for the devices.
        type: string
      identity:
        $ref: '#/definitions/ResourceIdentity'
        description: Msi identity of the resource
      kind:
        description: The kind of the device.
        enum:
        - AzureDataBoxGateway
        - AzureStackEdge
        - AzureStackHub
        - AzureModularDataCentre
        type: string
        x-ms-enum:
          name: DataBoxEdgeDeviceKind
          modelAsString: true
        readOnly: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: DataBoxEdge Resource
        readOnly: true
      properties:
        $ref: '#/definitions/DataBoxEdgeDeviceProperties'
        description: The properties of the Data Box Edge/Gateway device.
        x-ms-client-flatten: true
  NetworkInterfaceData0Settings:
    description: The 'Data 0' network interface card settings.
    type: object
    properties:
      controllerZeroIp:
        description: The controller 0's IPv4 address.
        type: string
      controllerOneIp:
        description: The controller 1's IPv4 address.
        type: string
  FailoverRequest:
    description: The request object for triggering a failover of volume containers, from a source device to a target device.
    type: object
    properties:
      targetDeviceId:
        description: The ARM path ID of the device which will act as the failover target.
        type: string
      volumeContainers:
        description: The list of path IDs of the volume containers which needs to be failed-over to the target device.
        type: array
        items:
          type: string
  CloudError:
    description: An error response from the service.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The error details.
    x-ms-external: true
  SignedCapabilityImageResponse:
    type: object
    description: Signed device capability image response
    properties:
      image:
        type: string
        description: The signed device capability image as a UTF-8 encoded base 64 string.
        readOnly: true
  DeviceListResult:
    type: object
    description: The response of a Device list operation.
    properties:
      value:
        type: array
        description: The Device items on this page
        items:
          $ref: '#/definitions/Device_3'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
        readOnly: true
    required:
    - value
  ProvisioningState:
    type: string
    description: Provisioning state of resource.
    enum:
    - Succeeded
    - Failed
    - Canceled
    - Provisioning
    - Updating
    - Deleting
    - Accepted
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
      values:
      - name: Succeeded
        value: Succeeded
        description: Resource has been created.
      - name: Failed
        value: Failed
        description: Resource creation failed.
      - name: Canceled
        value: Canceled
        description: Resource creation was canceled.
      - name: Provisioning
        value: Provisioning
        description: The resource is being provisioned
      - name: Updating
        value: Updating
        description: The resource is being updated
      - name: Deleting
        value: Deleting
        description: The resource is being deleted
      - name: Accepted
        value: Accepted
        description: The resource create request has been accepted
  Ipv4Config:
    description: Details related to the IPv4 address configuration.
    type: object
    properties:
      ipAddress:
        description: The IPv4 address of the network adapter.
        type: string
        readOnly: true
      subnet:
        description: The IPv4 subnet of the network adapter.
        type: string
        readOnly: true
      gateway:
        description: The IPv4 gateway of the network adapter.
        type: string
        readOnly: true
  InnerError:
    description: Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
    type: object
    properties:
      code:
        description: Specific error code than was provided by the containing error.
        type: string
      innererror:
        $ref: '#/definitions/InnerError'
  X509Certificates:
    description: The X509 certificates definition.
    type: object
    properties:
      primary:
        description: The primary X.509 certificate for this credential.
        $ref: '#/definitions/X509Certificate'
      secondary:
        description: The secondary X.509 certificate for this credential.
        $ref: '#/definitions/X509Certificate'
    required:
    - primary
  DeviceCommandCollection:
    description: The paged results of device command executions.
    type: object
    properties:
      value:
        description: The collection of device command executions.
        type: array
        items:
          $ref: '#/definitions/DeviceCommand'
      nextLink:
        description: URL to get the next page of device command executions.
        type: string
    required:
    - value
  AlertSettingsProperties:
    description: Class containing the properties of AlertSettings
    required:
    - emailNotification
    - notificationToServiceOwners
    - alertNotificationCulture
    type: object
    properties:
      emailNotification:
        description: Value indicating whether user/admins will receive emails when an alert condition occurs on the system
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: AlertEmailNotificationStatus
          modelAsString: false
      notificationToServiceOwners:
        description: Value indicating whether service owners will receive emails when an alert condition occurs on the system. Applicable only if emailNotification flag is Enabled.
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: ServiceOwnersAlertNotificationStatus
          modelAsString: false
      alertNotificationCulture:
        description: 'Culture setting to be used while building alert emails. For eg: "en-US"'
        type: string
      additionalRecipientEmailList:
        description: List of email addresses (apart from admin/co-admin of subscription) to whom the alert emails need to be sent
        type: array
        items:
          type: string
parameters:
  apiVersionParameter_2:
    name: api-version
    in: query
    description: The api version
    required: true
    type: string
    x-ms-skip-url-encoding: true
  CommandName:
    in: path
    name: commandName
    description: Name of this device command.
    x-ms-parameter-location: method
    type: string
    required: true
  managerNameParameter_2:
    name: managerName
    in: path
    description: The manager name
    required: true
    type: string
    maxLength: 50
    minLength: 2
    x-ms-parameter-location: method
  ComponentName:
    in: path
    name: componentName
    description: Name of the device component.
    x-ms-parameter-location: method
    type: string
    required: true
  Version:
    in: query
    name: api-version
    description: The version of the API being called.
    x-ms-parameter-location: client
    type: string
    required: true
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The resource group name.
    required: true
    type: string
    x-ms-parameter-location: method
  resourceGroupNameParameter_2:
    name: resourceGroupName
    in: path
    description: The resource group name
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  DeviceId:
    in: path
    name: deviceId
    description: Unique ID of the device.
    x-ms-parameter-location: method
    type: string
    required: true
  subscriptionIdParameter_2:
    name: subscriptionId
    in: path
    description: The subscription id
    required: true
    type: string
    x-ms-skip-url-encoding: true
  subscriptionIdParameter_3:
    name: subscriptionId
    in: path
    description: The subscription id
    required: true
    type: string
  TelemetryName:
    in: path
    name: telemetryName
    description: Name of this device telemetry.
    x-ms-parameter-location: method
    type: string
    required: true
  RelationshipId:
    in: path
    name: relationshipId
    description: Unique ID of a relationship between devices.
    x-ms-parameter-location: method
    type: string
    required: true
  Unmodeled:
    in: query
    name: unmodeled
    description: The query parameter for supporting unmodeled properties.
    x-ms-parameter-location: method
    type: boolean
    default: false
    required: false
  Filter:
    in: query
    name: filter
    description: An expression on the resource type that selects the resources to be returned.
    x-ms-parameter-location: method
    type: string
    required: false
  MaxPageSize:
    in: query
    name: maxpagesize
    description: The maximum number of resources to return from one response.
    x-ms-parameter-location: method
    type: integer
    format: int32
    minimum: 1
    maximum: 100
    required: false
  deviceNameParameter:
    name: deviceName
    in: path
    description: The device name
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  IfMatch:
    in: header
    name: If-Match
    description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
    x-ms-parameter-location: method
    type: string
    required: false
  ModuleName:
    in: path
    name: moduleName
    description: Name of the device module.
    x-ms-parameter-location: method
    type: string
    required: true
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription ID.
    required: true
    type: string
  managerNameParameter:
    name: managerName
    in: path
    description: The manager name
    required: true
    type: string
    maxLength: 50
    minLength: 2
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  OrderBy:
    in: query
    name: orderby
    description: An expression that specify the order of the returned resources.
    x-ms-parameter-location: method
    type: string
    required: false
  apiVersionParameter_3:
    name: api-version
    in: query
    description: The api version
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    description: The API version.
    required: true
    type: string
  resourceGroupNameParameter_3:
    name: resourceGroupName
    in: path
    description: The resource group name
    required: true
    type: string
    x-ms-parameter-location: method
  Expand:
    in: query
    name: expand
    description: The query parameter for including requested entities in response.
    x-ms-parameter-location: method
    type: string
    maxLength: 255
    pattern: ^[a-zA-Z0-9-]*$
    required: false
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'