swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector EdgeDevices API
schemes:
- https
tags:
- name: EdgeDevices
paths:
  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices:
    get:
      operationId: microsoftAzureEdgedevicesList
      tags:
      - EdgeDevices
      description: List EdgeDevice resources by parent
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/EdgeDeviceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List Edge Devices:
          $ref: ./examples/ListEdgeDevices.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Get Resourceuri Providers Microsoft Azurestackhci Edgedevices
  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}:
    get:
      operationId: microsoftAzureEdgedevicesGet
      tags:
      - EdgeDevices
      description: Get a EdgeDevice
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter'
      - name: edgeDeviceName
        in: path
        description: Name of Device
        required: true
        type: string
        default: default
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/EdgeDevice'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Edge Device:
          $ref: ./examples/GetEdgeDevices.json
      summary: Get Resourceuri Providers Microsoft Azurestackhci Edgedevices Edgedevicename
    put:
      operationId: microsoftAzureEdgedevicesCreateorupdate
      tags:
      - EdgeDevices
      description: Create a EdgeDevice
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter'
      - name: edgeDeviceName
        in: path
        description: Name of Device
        required: true
        type: string
        default: default
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/EdgeDevice'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/EdgeDevice'
        '201':
          description: Resource successfully created.
          schema:
            $ref: '#/definitions/EdgeDevice'
          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/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      x-ms-examples:
        Create HCI Edge Device:
          $ref: ./examples/CreateHciEdgeDevice.json
      summary: Put Resourceuri Providers Microsoft Azurestackhci Edgedevices Edgedevicename
    delete:
      operationId: microsoftAzureEdgedevicesDelete
      tags:
      - EdgeDevices
      description: Delete a EdgeDevice
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter'
      - name: edgeDeviceName
        in: path
        description: Name of Device
        required: true
        type: string
        default: default
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '202':
          description: Resource deletion 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.
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
        '204':
          description: Resource deleted successfully.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete Edge Devices:
          $ref: ./examples/DeleteEdgeDevices.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Delete Resourceuri Providers Microsoft Azurestackhci Edgedevices Edgedevicename
  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/validate:
    post:
      operationId: microsoftAzureEdgedevicesValidate
      tags:
      - EdgeDevices
      description: A long-running resource action.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter'
      - name: edgeDeviceName
        in: path
        description: Name of Device
        required: true
        type: string
        default: default
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: ValidateRequest
        in: body
        description: The content of the action request
        required: true
        schema:
          $ref: '#/definitions/ValidateRequest'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/ValidateResponse'
        '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.
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Validate Edge Devices:
          $ref: ./examples/ValidateEdgeDevices.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Post Resourceuri Providers Microsoft Azurestackhci Edgedevices Edgedevicename Validate
definitions:
  EdgeDevice:
    type: object
    description: Edge device resource.
    properties:
      kind:
        $ref: '#/definitions/DeviceKind'
        description: Device kind to support polymorphic resource.
        x-ms-mutability:
        - create
        - read
    discriminator: kind
    required:
    - kind
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
  EdgeDeviceListResult:
    type: object
    description: The response of a EdgeDevice list operation.
    properties:
      value:
        type: array
        description: The EdgeDevice items on this page
        items:
          $ref: '#/definitions/EdgeDevice'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  ValidateResponse:
    type: object
    description: An Accepted response with an Operation-Location header.
    properties:
      status:
        type: string
        description: edge device validation status
        readOnly: true
  ValidateRequest:
    type: object
    description: The validate request for Edge Device.
    properties:
      edgeDeviceIds:
        type: array
        description: Node Ids against which, current node has to be validated.
        items:
          type: string
      additionalInfo:
        type: string
        description: Additional info required for validation.
    required:
    - edgeDeviceIds
  DeviceKind:
    type: string
    description: Edge device kind.
    enum:
    - HCI
    default: HCI
    x-ms-enum:
      name: DeviceKind
      modelAsString: true
      values:
      - name: HCI
        value: HCI
        description: Arc-enabled edge device with HCI OS.
parameters:
  Azure.ResourceManager.ResourceUriParameter:
    name: resourceUri
    in: path
    description: The fully qualified Azure Resource manager identifier of the resource.
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'