# 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 ManagedLabsClient Global Users API
  version: 1.0.0
extends: openapi/microsoft-azure-globalusers-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: 10
- target: $.paths['/providers/Microsoft.LabServices/users/{userName}/getEnvironment'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a lab user's environment VM details
      effect: read
      questions:
      - How can a lab student see the connection details of their assigned virtual machine?
      - Where do I look up the VM behind one of my lab environments?
      instructions:
      - text: Get the VM details of environment {environmentId} for user {userName}.
        slots:
          userName: path.userName
          environmentId: requestBody.environmentId
      - text: Show user {userName}'s environment {environmentId} with expanded {expand}.
        slots:
          userName: path.userName
          environmentId: requestBody.environmentId
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.LabServices/users/{userName}/getOperationBatchStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check status of a batch of lab operations
      effect: read
      questions:
      - Can I check several long-running lab operations at once?
      - How do I get the status of a batch of lab environment operation URLs?
      instructions:
      - text: Get the batch status of operations {urls} for user {userName}.
        slots:
          userName: path.userName
          urls: requestBody.urls
      - text: Check whether all of {userName}'s pending lab operations have finished.
        slots:
          userName: path.userName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.LabServices/users/{userName}/getOperationStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check one long-running lab operation
      effect: read
      questions:
      - Has my lab environment start or stop finished yet?
      - How do I poll a single long-running Lab Services operation?
      instructions:
      - text: Get the status of operation {operationUrl} for user {userName}.
        slots:
          userName: path.userName
          operationUrl: requestBody.operationUrl
      - text: Check if {userName}'s long-running lab operation is done.
        slots:
          userName: path.userName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.LabServices/users/{userName}/getPersonalPreferences'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a lab user's personal preferences
      effect: read
      questions:
      - Which labs has a user marked as favorites in Lab Services?
      - Can I read one user's personal preferences for a lab account?
      instructions:
      - text: Get personal preferences for user {userName}.
        slots:
          userName: path.userName
      - text: Get {userName}'s preferences in lab account {labAccountResourceId}.
        slots:
          userName: path.userName
          labAccountResourceId: requestBody.labAccountResourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.LabServices/users/{userName}/listEnvironments'].post
  update:
    x-apievangelist-phrasing:
      intent: List a user's lab environments
      effect: read
      questions:
      - What lab environments has a student been given?
      - Can I list only the environments a user has in one specific lab?
      instructions:
      - text: List lab environments for user {userName}.
        slots:
          userName: path.userName
      - text: List {userName}'s environments in lab {labId}.
        slots:
          userName: path.userName
          labId: requestBody.labId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.LabServices/users/{userName}/listLabs'].post
  update:
    x-apievangelist-phrasing:
      intent: List labs a user belongs to
      effect: read
      questions:
      - Which classroom labs is a user registered in?
      - How do I see every lab available to one Lab Services user?
      instructions:
      - text: List labs for user {userName}.
        slots:
          userName: path.userName
      - text: Show which labs {userName} has joined.
        slots:
          userName: path.userName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.LabServices/users/{userName}/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a user to a managed lab
      effect: write
      questions:
      - How does a student join a lab using the registration code?
      - Can I enroll a user in a managed lab from the API?
      instructions:
      - text: Register user {userName} with lab code {registrationCode}.
        slots:
          userName: path.userName
          registrationCode: requestBody.registrationCode
      - text: Enroll {userName} in the managed lab.
        slots:
          userName: path.userName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.LabServices/users/{userName}/resetPassword'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a user's password on a lab environment
      effect: write
      questions:
      - A student forgot their lab VM password - how do I reset it for their environment?
      - Can I set a new username and password on a user's lab environment?
      instructions:
      - text: Reset the password on environment {environmentId} for user {userName}.
        slots:
          userName: path.userName
          environmentId: requestBody.environmentId
      - text: Set {userName}'s environment {environmentId} login to {username} / {password}.
        slots:
          userName: path.userName
          environmentId: requestBody.environmentId
          username: requestBody.username
          password: requestBody.password
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.LabServices/users/{userName}/startEnvironment'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a user's lab environment
      effect: write
      questions:
      - How does a student power on their lab environment?
      - Does starting a lab environment start every resource inside it?
      instructions:
      - text: Start environment {environmentId} for user {userName}.
        slots:
          userName: path.userName
          environmentId: requestBody.environmentId
      - text: Power on {userName}'s lab environment {environmentId}.
        slots:
          userName: path.userName
          environmentId: requestBody.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.LabServices/users/{userName}/stopEnvironment'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a user's lab environment
      effect: write
      questions:
      - How do I shut down a student's lab environment to save hours?
      - Will stopping a user's environment stop all the resources in it?
      instructions:
      - text: Stop environment {environmentId} for user {userName}.
        slots:
          userName: path.userName
          environmentId: requestBody.environmentId
      - text: Shut down {userName}'s lab environment {environmentId}.
        slots:
          userName: path.userName
          environmentId: requestBody.environmentId
      method: generated
      generated: '2026-09-26'