# 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 RunCommandsClient Virtual Machine Run…
  version: 1.0.0
extends: openapi/microsoft-azure-virtualmachineruncommands-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: 7
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands'].get
  update:
    x-apievangelist-phrasing:
      intent: List built-in run commands for a region
      effect: read
      questions:
      - Which built-in run commands can I use on VMs in a given Azure region?
      - What predefined scripts are available to run on virtual machines in a location?
      instructions:
      - text: List the available run commands in location {location}.
        slots:
          location: path.location
      - text: Show the built-in VM scripts offered in region {location}.
        slots:
          location: path.location
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a built-in run command's definition
      effect: read
      questions:
      - What script and parameters does a particular built-in run command use?
      - Can I look up one predefined run command by its command id in a region?
      instructions:
      - text: Show built-in run command {commandId} in location {location}.
        slots:
          commandId: path.commandId
          location: path.location
      - text: Get the script and parameters for predefined command {commandId} in {location}.
        slots:
          commandId: path.commandId
          location: path.location
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a run command on a specific VM
      effect: read
      questions:
      - What's the status and output of a run command I created on a VM?
      - Can I include the instance view when checking a VM run command?
      instructions:
      - text: Show run command {runCommandName} on VM {vmName} in resource group {resourceGroupName}.
        slots:
          runCommandName: path.runCommandName
          vmName: path.vmName
          resourceGroupName: path.resourceGroupName
      - text: Get run command {runCommandName} on {vmName} in {resourceGroupName} expanded with {expand}.
        slots:
          runCommandName: path.runCommandName
          vmName: path.vmName
          resourceGroupName: path.resourceGroupName
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a run command on a VM
      effect: write
      questions:
      - How do I run a script on an Azure virtual machine as a managed run command?
      - Can I replace a run command on a VM with a new script definition?
      instructions:
      - text: Create run command {runCommandName} on VM {vmName} in resource group {resourceGroupName} with properties {properties}.
        slots:
          runCommandName: path.runCommandName
          vmName: path.vmName
          resourceGroupName: path.resourceGroupName
          properties: requestBody.properties
      - text: Run a new script as command {runCommandName} on {vmName} in {resourceGroupName}.
        slots:
          runCommandName: path.runCommandName
          vmName: path.vmName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a run command from a VM
      effect: destructive
      questions:
      - How do I clean up a run command I no longer need on a VM?
      - Can I remove a managed run command from a virtual machine?
      instructions:
      - text: Delete run command {runCommandName} from VM {vmName} in resource group {resourceGroupName}.
        slots:
          runCommandName: path.runCommandName
          vmName: path.vmName
          resourceGroupName: path.resourceGroupName
      - text: Remove command {runCommandName} from {vmName} in {resourceGroupName}.
        slots:
          runCommandName: path.runCommandName
          vmName: path.vmName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Modify an existing run command on a VM
      effect: write
      questions:
      - How do I change just some settings on a run command that already exists on my VM?
      - Can I patch an existing VM run command instead of recreating it?
      instructions:
      - text: Patch existing run command {runCommandName} on VM {vmName} in resource group {resourceGroupName} with {properties}.
        slots:
          runCommandName: path.runCommandName
          vmName: path.vmName
          resourceGroupName: path.resourceGroupName
          properties: requestBody.properties
      - text: Update the settings of command {runCommandName} already on {vmName} in {resourceGroupName}.
        slots:
          runCommandName: path.runCommandName
          vmName: path.vmName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands'].get
  update:
    x-apievangelist-phrasing:
      intent: List run commands on a VM
      effect: read
      questions:
      - What run commands have been created on one of my virtual machines?
      - Can I list a VM's run commands with their instance view expanded?
      instructions:
      - text: List the run commands on VM {vmName} in resource group {resourceGroupName}.
        slots:
          vmName: path.vmName
          resourceGroupName: path.resourceGroupName
      - text: Show every run command on {vmName} in {resourceGroupName} expanded with {expand}.
        slots:
          vmName: path.vmName
          resourceGroupName: path.resourceGroupName
          expand: query.$expand
      method: generated
      generated: '2026-09-26'