# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure DataBoxEdgeManagementClient Orders API
  version: 1.0.0
extends: openapi/microsoft-azure-orders-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List orders for a Data Box Edge device
      effect: read
      questions:
      - What orders exist for my Data Box Edge or Gateway device?
      - Can I see the order history for one Data Box Edge device?
      instructions:
      - text: List orders for Data Box Edge device {deviceName} in {resourceGroupName} of subscription {subscriptionId}.
        slots:
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show all orders tied to device {deviceName}.
        slots:
          deviceName: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the order for a Data Box Edge device
      effect: read
      questions:
      - What is the status of the hardware order for my Data Box Edge device?
      - Can I look up the order placed for one Data Box Edge device?
      instructions:
      - text: Show the order for Data Box Edge device {deviceName}.
        slots:
          deviceName: path.deviceName
      - text: Get the order status for device {deviceName} in resource group {rg}.
        slots:
          deviceName: path.deviceName
          rg: path.resourceGroupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a Data Box Edge device order
      effect: write
      questions:
      - How do I place an order for a Data Box Edge device?
      - Can I update the contact or shipping details on an existing device order?
      instructions:
      - text: Place an order for device {deviceName} in {resourceGroupName} of subscription {subscriptionId} with {properties}.
        slots:
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
          properties: requestBody.properties
      - text: Update the order for Data Box Edge {deviceName}.
        slots:
          deviceName: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Data Box Edge device order
      effect: destructive
      questions:
      - Can I delete the order related to a Data Box Edge device?
      - What removes a device order I placed by mistake?
      instructions:
      - text: Delete the order for device {deviceName} in {resourceGroupName} of subscription {subscriptionId}.
        slots:
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove the Data Box Edge {deviceName} order.
        slots:
          deviceName: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default/listDCAccessCode'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the datacenter access code for a device order
      effect: read
      questions:
      - Where do I get the datacenter access code for a Data Box Edge order?
      - Can I retrieve the DC access code needed when returning a device?
      instructions:
      - text: Get the DC access code for device {deviceName} in {resourceGroupName} of subscription {subscriptionId}.
        slots:
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Retrieve the datacenter access code for Data Box Edge {deviceName}.
        slots:
          deviceName: path.deviceName
      method: generated
      generated: '2026-09-26'