swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Order API
schemes:
- https
tags:
- name: Order
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orders:
    get:
      tags:
      - Order
      description: List orders at subscription level.
      operationId: microsoftAzureOrdersListbysubscription
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: $skipToken
        in: query
        description: $skipToken is supported on Get list of orders, which provides the next page in the list of orders.
        required: false
        type: string
      - name: $top
        in: query
        description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: List of orders available under the subscription.
          schema:
            $ref: '#/definitions/OrderResourceList'
        default:
          description: Error response describing reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ListOrderAtSubscriptionLevel:
          $ref: ./examples/ListOrderAtSubscriptionLevel.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Edgeorder Orders
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/locations/{location}/orders/{orderName}
  : get:
      tags:
      - Order
      description: Get an order.
      operationId: microsoftAzureOrdersGet
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter
      - $ref: '#/parameters/orderNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Order resource object.
          schema:
            $ref: '#/definitions/OrderResource'
        default:
          description: Error response describing reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        GetOrderByName:
          $ref: ./examples/GetOrderByName.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Edgeorder Locations Location Orders Ordername
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orders:
    get:
      tags:
      - Order
      description: List orders at resource group level.
      operationId: microsoftAzureOrdersListbyresourcegroup
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: $skipToken
        in: query
        description: $skipToken is supported on Get list of orders, which provides the next page in the list of orders.
        required: false
        type: string
      - name: $top
        in: query
        description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: List of orders available under the resource group.
          schema:
            $ref: '#/definitions/OrderResourceList'
        default:
          description: Error response describing reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ListOrderAtResourceGroupLevel:
          $ref: ./examples/ListOrderAtResourceGroupLevel.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Edgeorder Orders
definitions:
  OrderResourceList:
    description: List of orders.
    type: object
    properties:
      value:
        description: List of order resources.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/OrderResource'
        readOnly: true
      nextLink:
        description: Link for the next set of order resources.
        type: string
  OrderProperties:
    description: Represents order details.
    type: object
    properties:
      orderItemIds:
        description: List of order item ARM Ids which are part of an order.
        uniqueItems: false
        type: array
        items:
          type: string
        readOnly: true
      currentStage:
        $ref: '#/definitions/StageDetails'
        description: Order current status.
        readOnly: true
      orderStageHistory:
        description: Order status history.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/StageDetails'
        readOnly: true
        x-ms-identifiers: []
      orderMode:
        description: Order mode.
        enum:
        - Default
        - DoNotFulfill
        type: string
        readOnly: true
        x-ms-enum:
          name: OrderMode
          modelAsString: true
          values:
          - value: Default
            description: Default Order mode.
          - value: DoNotFulfill
            description: Mode in which the Order will not be fulfilled.
  StageDetails:
    description: Resource stage details.
    type: object
    properties:
      stageStatus:
        description: Stage status.
        enum:
        - None
        - InProgress
        - Succeeded
        - Failed
        - Cancelled
        - Cancelling
        type: string
        readOnly: true
        x-ms-enum:
          name: StageStatus
          modelAsString: true
          values:
          - value: None
            description: No status available yet.
          - value: InProgress
            description: Stage is in progress.
          - value: Succeeded
            description: Stage has succeeded.
          - value: Failed
            description: Stage has failed.
          - value: Cancelled
            description: Stage has been cancelled.
          - value: Cancelling
            description: Stage is cancelling.
      stageName:
        description: Stage name.
        enum:
        - Placed
        - InReview
        - Confirmed
        - ReadyToShip
        - Shipped
        - Delivered
        - InUse
        - ReturnInitiated
        - ReturnPickedUp
        - ReturnedToMicrosoft
        - ReturnCompleted
        - Cancelled
        type: string
        readOnly: true
        x-ms-enum:
          name: StageName
          modelAsString: true
          values:
          - value: Placed
            description: Currently in draft mode and can still be cancelled.
          - value: InReview
            description: Order is currently in draft mode and can still be cancelled.
          - value: Confirmed
            description: Order is confirmed.
          - value: ReadyToShip
            description: Order is ready to ship.
          - value: Shipped
            description: Order is in transit to customer.
          - value: Delivered
            description: Order is delivered to customer.
          - value: InUse
            description: Order is in use at customer site.
          - value: ReturnInitiated
            description: Return has been initiated by customer.
          - value: ReturnPickedUp
            description: Order is in transit from customer to Microsoft.
          - value: ReturnedToMicrosoft
            description: Order has been received back to Microsoft.
          - value: ReturnCompleted
            description: Return has now completed.
          - value: Cancelled
            description: Order has been cancelled.
      displayName:
        description: Display name of the resource stage.
        type: string
        readOnly: true
      startTime:
        format: date-time
        description: Stage start time.
        type: string
        readOnly: true
  OrderResource:
    description: Specifies the properties or parameters for an order. Order is a grouping of one or more order items.
    required:
    - properties
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
    properties:
      properties:
        $ref: '#/definitions/OrderProperties'
        description: Order properties.
        x-ms-client-flatten: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Represents resource creation and update time.
        readOnly: true
parameters:
  orderNameParameter:
    name: orderName
    in: path
    description: The name of the order.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'