swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Nodes API
schemes:
- https
tags:
- name: Nodes
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/nodes
  : get:
      tags:
      - Nodes
      description: Gets all the nodes currently configured under this Data Box Edge device
      operationId: microsoftAzureNodesListbydataboxedgedevice
      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 collection of all nodes on the device.
          schema:
            $ref: '#/definitions/NodeList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        NodesGetAllInDevice:
          $ref: ./examples/NodeGetAllInDevice.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Nodes
definitions:
  NodeProperties:
    description: This class represents the nodes in a highly available cluster
    type: object
    properties:
      nodeStatus:
        description: The current status of the individual node
        enum:
        - Unknown
        - Up
        - Down
        - Rebooting
        - ShuttingDown
        type: string
        readOnly: true
        x-ms-enum:
          name: NodeStatus
          modelAsString: true
      nodeChassisSerialNumber:
        description: Serial number of the Chassis
        type: string
        readOnly: true
      nodeSerialNumber:
        description: Serial number of the individual node
        type: string
        readOnly: true
      nodeDisplayName:
        description: Display Name of the individual node
        type: string
        readOnly: true
      nodeFriendlySoftwareVersion:
        description: Friendly software version name that is currently installed on the node
        type: string
        readOnly: true
      nodeHcsVersion:
        description: HCS version that is currently installed on the node
        type: string
        readOnly: true
      nodeInstanceId:
        description: Guid instance id of the node
        type: string
        readOnly: 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
  CloudError:
    description: An error response from the service.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The error details.
    x-ms-external: 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
  Node:
    description: "Represents a single node in a Data box Edge/Gateway device\r\nGateway devices, standalone Edge devices and a single node cluster Edge device will all have 1 node\r\nMulti-node Edge devices will have more than 1 nodes"
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      properties:
        $ref: '#/definitions/NodeProperties'
        description: The properties of the node
        readOnly: true
        x-ms-client-flatten: true
  NodeList:
    description: Collection of Nodes.
    type: object
    properties:
      value:
        description: The list of Nodes.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/Node'
        readOnly: true
        x-ms-identifiers: []
      nextLink:
        description: Link to the next set of results.
        type: string
        readOnly: true
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription ID.
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    description: The API version.
    required: true
    type: string
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The resource group name.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'