# 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 Users API
  version: 1.0.0
extends: openapi/microsoft-azure-users-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 19
- target: $.paths['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in an application
      effect: read
      questions:
      - Who are the users in my application?
      - Can I page through application users with a maximum page size?
      instructions:
      - text: List the users in my application.
      - text: List application users, {maxpagesize} per page.
        slots:
          maxpagesize: query.maxpagesize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application user by ID
      effect: read
      questions:
      - How do I look up one user in my application by their ID?
      - What roles does a particular application user have?
      instructions:
      - text: Get application user {userId}.
        slots:
          userId: path.userId
      - text: Show the roles and type of application user {userId}.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a user in an application
      effect: write
      questions:
      - Can I add a user to my application with specific roles?
      - What do I need to create an application user, like type and roles?
      instructions:
      - text: Create application user {userId} of type {type} with roles {roles}.
        slots:
          userId: path.userId
          type: requestBody.type
          roles: requestBody.roles
      - text: Add user {userId} to the application with roles {roles}.
        slots:
          userId: path.userId
          roles: requestBody.roles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application user
      effect: destructive
      questions:
      - How do I remove a user from my application?
      - Can I revoke someone's access by deleting their application user?
      instructions:
      - text: Delete application user {userId}.
        slots:
          userId: path.userId
      - text: Remove user {userId} from the application.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an application user
      effect: write
      questions:
      - Can I patch an existing application user without recreating them?
      - Does updating an application user support an If-Match concurrency check?
      instructions:
      - text: Update application user {userId}.
        slots:
          userId: path.userId
      - text: Patch the application user with ID {userId}.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users on a Data Box Edge device
      effect: read
      questions:
      - Which users are registered on my Data Box Edge or Data Box Gateway device?
      - Can I filter the users on a Data Box Gateway device?
      instructions:
      - text: List users on Data Box Edge device {deviceName}.
        slots:
          deviceName: path.deviceName
      - text: List users on Data Box Gateway device {deviceName} matching {filter}.
        slots:
          deviceName: path.deviceName
          filter: query.$filter
      - text: List users on device {deviceName} in {resourceGroupName} of subscription {subscriptionId}.
        slots:
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user on a Data Box Edge device
      effect: read
      questions:
      - How do I see the properties of one user on a Data Box Edge device?
      - What does a Data Box Gateway user record contain?
      instructions:
      - text: Get user {name} on Data Box Edge device {deviceName}.
        slots:
          name: path.name
          deviceName: path.deviceName
      - text: Show Data Box Gateway user {name} on device {deviceName}.
        slots:
          name: path.name
          deviceName: path.deviceName
      - text: Fetch device {deviceName} user {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          deviceName: path.deviceName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a user on a Data Box Edge device
      effect: write
      questions:
      - Can I add a new local user to a Data Box Edge device?
      - How do I change an existing user's information on a Data Box Gateway?
      instructions:
      - text: Create user {name} on Data Box Edge device {deviceName}.
        slots:
          name: path.name
          deviceName: path.deviceName
      - text: Update Data Box Gateway user {name} on {deviceName} with properties {properties}.
        slots:
          name: path.name
          deviceName: path.deviceName
          properties: requestBody.properties
      - text: Add local user {name} to device {deviceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user from a Data Box Edge device
      effect: destructive
      questions:
      - How do I remove a user from a Data Box Edge or Gateway device?
      - Can I delete a local share user from my Data Box Gateway?
      instructions:
      - text: Delete user {name} from Data Box Edge device {deviceName}.
        slots:
          name: path.name
          deviceName: path.deviceName
      - text: Remove Data Box Gateway user {name} on device {deviceName}.
        slots:
          name: path.name
          deviceName: path.deviceName
      - text: Delete local user {name} on device {deviceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List user profiles in a DevTest Lab
      effect: read
      questions:
      - Who has a user profile in my DevTest Lab?
      - Can I sort or limit the DevTest Labs user profiles returned?
      instructions:
      - text: List user profiles in DevTest lab {labName}.
        slots:
          labName: path.labName
      - text: List the top {top} user profiles in DevTest lab {labName} ordered by {orderby}.
        slots:
          top: query.$top
          labName: path.labName
          orderby: query.$orderby
      - text: List lab {labName} user profiles in {resourceGroupName} of subscription {subscriptionId}.
        slots:
          labName: path.labName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DevTest Lab user profile
      effect: read
      questions:
      - How do I get one user's profile in a DevTest Lab?
      - What does a DevTest Labs user profile include?
      instructions:
      - text: Get user profile {name} in DevTest lab {labName}.
        slots:
          name: path.name
          labName: path.labName
      - text: Show DevTest Labs user {name} in lab {labName}.
        slots:
          name: path.name
          labName: path.labName
      - text: Fetch user profile {name} of lab {labName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          labName: path.labName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a DevTest Lab user profile
      effect: write
      questions:
      - Can I create a user profile in a DevTest Lab?
      - Why might creating a DevTest Labs user profile take a while to finish?
      instructions:
      - text: Create user profile {name} in DevTest lab {labName}.
        slots:
          name: path.name
          labName: path.labName
      - text: Replace DevTest Labs user profile {name} in {labName} in location {location}.
        slots:
          name: path.name
          labName: path.labName
          location: requestBody.location
      - text: Create lab {labName} user profile {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          labName: path.labName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DevTest Lab user profile
      effect: destructive
      questions:
      - How do I delete someone's user profile from a DevTest Lab?
      - Is deleting a DevTest Labs user profile a long-running operation?
      instructions:
      - text: Delete user profile {name} from DevTest lab {labName}.
        slots:
          name: path.name
          labName: path.labName
      - text: Remove DevTest Labs user {name} in lab {labName}.
        slots:
          name: path.name
          labName: path.labName
      - text: Delete lab {labName} user profile {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          labName: path.labName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update tags on a DevTest Lab user profile
      effect: write
      questions:
      - Can I change the tags on a DevTest Labs user profile?
      - What fields can be modified on an existing DevTest Lab user profile?
      instructions:
      - text: Set tags {tags} on user profile {name} in DevTest lab {labName}.
        slots:
          tags: requestBody.tags
          name: path.name
          labName: path.labName
      - text: Retag DevTest Labs user {name} in lab {labName}.
        slots:
          name: path.name
          labName: path.labName
      - text: Tag lab {labName} user profile {name} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          labName: path.labName
          name: path.name
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in a Lab Services classroom lab
      effect: read
      questions:
      - Which students are users in my Lab Services lab?
      - Can I filter the users of a lab under a lab account?
      instructions:
      - text: List users in lab {labName} of lab account {labAccountName}.
        slots:
          labName: path.labName
          labAccountName: path.labAccountName
      - text: List Lab Services users in {labName} under {labAccountName} filtered by {filter}.
        slots:
          labName: path.labName
          labAccountName: path.labAccountName
          filter: query.$filter
      - text: List users of classroom lab {labName} under {labAccountName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          labName: path.labName
          labAccountName: path.labAccountName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user in a Lab Services lab
      effect: read
      questions:
      - How do I look up one user in a Lab Services lab?
      - What details does Lab Services keep about a lab user?
      instructions:
      - text: Get user {userName} in lab {labName} of lab account {labAccountName}.
        slots:
          userName: path.userName
          labName: path.labName
          labAccountName: path.labAccountName
      - text: Show Lab Services user {userName} in {labName}.
        slots:
          userName: path.userName
          labName: path.labName
      - text: Fetch classroom lab user {userName} under {labAccountName}/{labName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          userName: path.userName
          labAccountName: path.labAccountName
          labName: path.labName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a Lab Services lab user
      effect: write
      questions:
      - Can I add a user to a lab under a Lab Services lab account?
      - How do I replace an existing user in a Lab Services lab?
      instructions:
      - text: Create user {userName} in lab {labName} of lab account {labAccountName}.
        slots:
          userName: path.userName
          labName: path.labName
          labAccountName: path.labAccountName
      - text: Replace Lab Services user {userName} in {labName} with tags {tags}.
        slots:
          userName: path.userName
          labName: path.labName
          tags: requestBody.tags
      - text: Add classroom lab user {userName} to {labAccountName}/{labName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          userName: path.userName
          labAccountName: path.labAccountName
          labName: path.labName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user from a Lab Services lab
      effect: destructive
      questions:
      - How do I remove a student from a Lab Services lab?
      - Is deleting a Lab Services lab user asynchronous?
      instructions:
      - text: Delete user {userName} from lab {labName} in lab account {labAccountName}.
        slots:
          userName: path.userName
          labName: path.labName
          labAccountName: path.labAccountName
      - text: Remove Lab Services user {userName} from {labName}.
        slots:
          userName: path.userName
          labName: path.labName
      - text: Delete classroom lab user {userName} from {labAccountName}/{labName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          userName: path.userName
          labAccountName: path.labAccountName
          labName: path.labName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Modify a user in a Lab Services lab
      effect: write
      questions:
      - Can I modify properties of a user in a Lab Services lab?
      - What can I patch on an existing Lab Services lab user?
      instructions:
      - text: Update user {userName} in lab {labName} of lab account {labAccountName}.
        slots:
          userName: path.userName
          labName: path.labName
          labAccountName: path.labAccountName
      - text: Patch Lab Services user {userName} in {labName} with properties {properties}.
        slots:
          userName: path.userName
          labName: path.labName
          properties: requestBody.properties
      - text: Modify classroom lab user {userName} in {labAccountName}/{labName}, {resourceGroupName}, subscription {subscriptionId}.
        slots:
          userName: path.userName
          labAccountName: path.labAccountName
          labName: path.labName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'