# 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 Shares API
  version: 1.0.0
extends: openapi/microsoft-azure-shares-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}/shares'].get
  update:
    x-apievangelist-phrasing:
      intent: List shares on a Data Box Edge device
      effect: read
      questions:
      - Which shares are configured on my Data Box Edge or Data Box Gateway device?
      - How do I see all file shares on a gateway device?
      instructions:
      - text: List shares on device {device} in {group}, subscription {sub}.
        slots:
          device: path.deviceName
          group: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show every share on Data Box Gateway {device} in resource group {group}.
        slots:
          device: path.deviceName
          group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a share on a Data Box Edge device
      effect: read
      questions:
      - What are the properties of one share on my Data Box Edge device?
      - Can I look up a Data Box Gateway share by name?
      instructions:
      - text: Get share {name} on Data Box Edge device {deviceName}.
        slots:
          name: path.name
          deviceName: path.deviceName
      - text: Show the settings of share {name} on device {deviceName} in {resourceGroupName}.
        slots:
          name: path.name
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a share on a device
      effect: write
      questions:
      - How do I create a new share on a Data Box Edge device?
      - Can I change an existing device share's properties?
      instructions:
      - text: Create share {share} on device {device} in {group}, subscription {sub}, with {properties}.
        slots:
          share: path.name
          device: path.deviceName
          group: path.resourceGroupName
          properties: requestBody.properties
          sub: path.subscriptionId
      - text: Update share {share} on device {device} ({group}) to {properties}.
        slots:
          share: path.name
          device: path.deviceName
          group: path.resourceGroupName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a share from a Data Box Edge device
      effect: destructive
      questions:
      - How do I remove a share from my Data Box Edge device?
      - Can I delete a share on a Data Box Gateway I no longer use?
      instructions:
      - text: Delete share {name} from Data Box Edge device {deviceName}.
        slots:
          name: path.name
          deviceName: path.deviceName
      - text: Remove share {name} on device {deviceName} in {resourceGroupName}.
        slots:
          name: path.name
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh a share's metadata from the cloud
      effect: write
      questions:
      - How do I sync a device share's metadata with what's in the cloud?
      - Can I refresh a share so it reflects cloud data?
      instructions:
      - text: Refresh share {share} on device {device} in {group}, subscription {sub}.
        slots:
          share: path.name
          device: path.deviceName
          group: path.resourceGroupName
          sub: path.subscriptionId
      - text: Pull cloud metadata into share {share} on device {device} ({group}).
        slots:
          share: path.name
          device: path.deviceName
          group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'