# 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 Devices API
  version: 1.0.0
extends: openapi/microsoft-azure-devices-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: 93
- target: $.paths['/sensor-partners/{sensorPartnerId}/devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List a sensor partner's farm devices
      effect: read
      questions:
      - Which field sensor devices are registered under a sensor partner in Data Manager for Agriculture?
      - Can I filter a sensor partner's devices by status, parent device or device data model?
      - How do I find farm devices created or modified within a date range?
      instructions:
      - text: List devices for sensor partner {partner}.
        slots:
          partner: path.sensorPartnerId
      - text: Show sensor partner {partner}'s devices with status {statuses}.
        slots:
          partner: path.sensorPartnerId
          statuses: query.statuses
      - text: List devices under partner {partner} whose parent device is {parent}.
        slots:
          partner: path.sensorPartnerId
          parent: query.parentDeviceIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sensor-partners/{sensorPartnerId}/devices/{deviceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sensor partner's farm device
      effect: read
      questions:
      - How do I look up one agriculture sensor device by its ID?
      - What hardware ID and reporting interval does a sensor partner device have?
      instructions:
      - text: Get device {device} of sensor partner {partner}.
        slots:
          device: path.deviceId
          partner: path.sensorPartnerId
      - text: Show the reporting interval and location of farm device {device}.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sensor-partners/{sensorPartnerId}/devices/{deviceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sensor partner's farm device
      effect: destructive
      questions:
      - How do I remove a retired field sensor device from a sensor partner?
      - Can I delete an agriculture device entity by its ID?
      instructions:
      - text: Delete device {device} from sensor partner {partner}.
        slots:
          device: path.deviceId
          partner: path.sensorPartnerId
      - text: Remove the farm sensor device {device}.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sensor-partners/{sensorPartnerId}/devices/{deviceId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Create or update a sensor partner's farm device
      effect: write
      questions:
      - How do I register a new field sensor device under a sensor partner?
      - Can I set a device's hardware ID, data model and reporting interval in Data Manager for Agriculture?
      instructions:
      - text: Create farm device {device} for partner {partner} using data model {model}.
        slots:
          device: path.deviceId
          partner: path.sensorPartnerId
          model: requestBody.deviceDataModelId
      - text: Set the reporting interval of agriculture device {device} to {seconds} seconds.
        slots:
          device: path.deviceId
          seconds: requestBody.reportingIntervalInSeconds
      - text: Register hardware {hardware} as device {device} under sensor partner {partner}.
        slots:
          hardware: requestBody.hardwareId
          device: path.deviceId
          partner: path.sensorPartnerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List devices in an IoT Central app
      effect: read
      questions:
      - What devices are connected to my IoT Central application?
      - Can I filter and sort the IoT Central device list with OData options?
      instructions:
      - text: List all devices in my IoT Central application.
      - text: List IoT Central devices matching {filter} ordered by {orderby}.
        slots:
          filter: query.filter
          orderby: query.orderby
      - text: Show up to {max} IoT Central devices.
        slots:
          max: query.maxpagesize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IoT Central device
      effect: read
      questions:
      - How do I see the template, enabled flag and provisioning state of one IoT Central device?
      - Is a given IoT Central device simulated or real?
      instructions:
      - text: Get IoT Central device {device}.
        slots:
          device: path.deviceId
      - text: Show whether device {device} is provisioned and enabled.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace an IoT Central device
      effect: write
      questions:
      - How do I add a new device to my IoT Central application?
      - Can I create a simulated device with a specific device template?
      instructions:
      - text: Create IoT Central device {device} named {name} using template {template}.
        slots:
          device: path.deviceId
          name: requestBody.displayName
          template: requestBody.template
      - text: Add simulated device {device} to the application.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IoT Central device
      effect: destructive
      questions:
      - How do I remove a device from my IoT Central application?
      - Can I delete an IoT Central device by ID?
      instructions:
      - text: Delete IoT Central device {device}.
        slots:
          device: path.deviceId
      - text: Remove device {device} from the IoT Central app.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an IoT Central device
      effect: write
      questions:
      - Can I disable or rename an existing IoT Central device without recreating it?
      - How do I make a partial update to an IoT Central device only if its etag still matches?
      instructions:
      - text: Patch IoT Central device {device}.
        slots:
          device: path.deviceId
      - text: Update device {device} only if its etag matches {etag}.
        slots:
          device: path.deviceId
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/applyDeploymentManifest'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a deployment manifest to an edge device
      effect: write
      questions:
      - How do I push an IoT Edge deployment manifest to a device in IoT Central?
      - Can I change which modules an edge device runs by applying a manifest?
      instructions:
      - text: Apply deployment manifest {manifest} to edge device {device}.
        slots:
          manifest: requestBody.data
          device: path.deviceId
      - text: Deploy the module configuration {manifest} to IoT Edge device {device}.
        slots:
          manifest: requestBody.data
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/attestation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device's individual attestation
      effect: read
      questions:
      - Which attestation mechanism does a specific IoT Central device use?
      - How do I view the individual enrollment attestation of a device?
      instructions:
      - text: Get the attestation for device {device}.
        slots:
          device: path.deviceId
      - text: Show how device {device} authenticates when provisioning.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/attestation'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an individual device attestation
      effect: write
      questions:
      - How do I give one IoT Central device its own X.509 or symmetric key attestation?
      - Can I set up an individual enrollment for a device instead of a group one?
      instructions:
      - text: Create a {type} attestation for device {device}.
        slots:
          type: requestBody.type
          device: path.deviceId
      - text: Set up individual enrollment attestation on device {device}.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/attestation'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a device's individual attestation
      effect: destructive
      questions:
      - How do I delete the individual attestation from an IoT Central device?
      - Can a device go back to group enrollment after removing its own attestation?
      instructions:
      - text: Remove the individual attestation from device {device}.
        slots:
          device: path.deviceId
      - text: Delete device {device}'s enrollment credentials.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/attestation'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a device's individual attestation
      effect: write
      questions:
      - Can I rotate or modify the individual attestation already set on a device?
      - How do I patch an existing device attestation in IoT Central?
      instructions:
      - text: Patch the existing attestation of device {device}.
        slots:
          device: path.deviceId
      - text: Update individual attestation keys for device {device}.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/commands/{commandName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device command's history
      effect: read
      questions:
      - How do I see past runs and responses of a command sent to a device?
      - Did the last reboot command on my IoT Central device succeed?
      instructions:
      - text: Pull the device-level run log for {command} on {device}.
        slots:
          command: path.commandName
          device: path.deviceId
      - text: Show past executions of {command} for device {device}.
        slots:
          command: path.commandName
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/commands/{commandName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a command on a device
      effect: write
      questions:
      - How do I send a direct command to an IoT Central device?
      - Can I set connection and response timeouts when running a device command?
      instructions:
      - text: Run command {command} on device {device}.
        slots:
          command: path.commandName
          device: path.deviceId
      - text: Send {command} to device {device} with payload {request}.
        slots:
          command: path.commandName
          device: path.deviceId
          request: requestBody.request
      - text: Execute {command} on {device} with a {timeout}-second response timeout.
        slots:
          command: path.commandName
          device: path.deviceId
          timeout: requestBody.responseTimeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/components'].get
  update:
    x-apievangelist-phrasing:
      intent: List a device's components
      effect: read
      questions:
      - Which components does an IoT Central device expose?
      - What are the component names defined on a device's model?
      instructions:
      - text: List the components on device {device}.
        slots:
          device: path.deviceId
      - text: Show every component present on {device}.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/components/{componentName}/commands/{commandName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a component command's history
      effect: read
      questions:
      - How do I check previous runs of a command on a specific device component?
      - What did a component-level command return last time it ran?
      instructions:
      - text: Get the history of command {command} on component {component} of device {device}.
        slots:
          command: path.commandName
          component: path.componentName
          device: path.deviceId
      - text: Show past {command} results for component {component}.
        slots:
          command: path.commandName
          component: path.componentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/components/{componentName}/commands/{commandName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a command on a device component
      effect: write
      questions:
      - How do I invoke a command defined on one component of a device?
      - Can I run a component command with a custom request payload?
      instructions:
      - text: Run command {command} on component {component} of device {device}.
        slots:
          command: path.commandName
          component: path.componentName
          device: path.deviceId
      - text: Call {command} on the {component} component of {device}, sending {request}.
        slots:
          command: path.commandName
          device: path.deviceId
          component: path.componentName
          request: requestBody.request
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/components/{componentName}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device component's properties
      effect: read
      questions:
      - What property values does one component of my device currently report?
      - Can I include unmodeled properties when reading a component's properties?
      instructions:
      - text: Get the properties of component {component} on device {device}.
        slots:
          component: path.componentName
          device: path.deviceId
      - text: Show component {component}'s properties on {device}, including unmodeled ones.
        slots:
          component: path.componentName
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/components/{componentName}/properties'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a device component's properties
      effect: write
      questions:
      - How do I overwrite every writable property on a device component at once?
      - Can I replace all of a component's property values in one call?
      instructions:
      - text: Replace all properties of component {component} on device {device}.
        slots:
          component: path.componentName
          device: path.deviceId
      - text: Overwrite the full property set of {component} for {device}.
        slots:
          component: path.componentName
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/components/{componentName}/properties'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update some device component properties
      effect: write
      questions:
      - Can I change a single writable property on a device component without touching the rest?
      - How do I partially update a component's properties?
      instructions:
      - text: Patch selected properties of component {component} on device {device}.
        slots:
          component: path.componentName
          device: path.deviceId
      - text: Change one setting in the {component} component of {device}.
        slots:
          component: path.componentName
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/components/{componentName}/telemetry/{telemetryName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get last telemetry value from a component
      effect: read
      questions:
      - What was the most recent temperature reading from a device component?
      - How do I read the latest telemetry value a specific component sent?
      instructions:
      - text: Get the last {telemetry} value from component {component} of device {device}.
        slots:
          telemetry: path.telemetryName
          component: path.componentName
          device: path.deviceId
      - text: Show component {component}'s latest {telemetry} reading.
        slots:
          component: path.componentName
          telemetry: path.telemetryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device's connection credentials
      effect: read
      questions:
      - How do I get the keys or certificates a device uses to connect to IoT Central?
      - Where do I find the ID scope and credentials for provisioning a device?
      instructions:
      - text: Get the connection credentials for device {device}.
        slots:
          device: path.deviceId
      - text: Show the provisioning keys of {device}.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules'].get
  update:
    x-apievangelist-phrasing:
      intent: List modules on an edge device
      effect: read
      questions:
      - Which IoT Edge modules are running on a device?
      - What modules does my IoT Central edge device contain?
      instructions:
      - text: List the modules on device {device}.
        slots:
          device: path.deviceId
      - text: Show all edge modules present on {device}.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules/{moduleName}/commands/{commandName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a module command's history
      effect: read
      questions:
      - How do I review previous runs of a command sent to an edge module?
      - What response did an IoT Edge module give to its last command?
      instructions:
      - text: Get the history of command {command} on module {module} of device {device}.
        slots:
          command: path.commandName
          module: path.moduleName
          device: path.deviceId
      - text: Show past {command} runs on module {module}.
        slots:
          command: path.commandName
          module: path.moduleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules/{moduleName}/commands/{commandName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a command on an edge module
      effect: write
      questions:
      - How do I send a command to an IoT Edge module on a device?
      - Can I call a module's command with a response timeout?
      instructions:
      - text: Run command {command} on module {module} of device {device}.
        slots:
          command: path.commandName
          module: path.moduleName
          device: path.deviceId
      - text: Send {command} to edge module {module} with payload {request}.
        slots:
          command: path.commandName
          module: path.moduleName
          request: requestBody.request
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules/{moduleName}/components'].get
  update:
    x-apievangelist-phrasing:
      intent: List components inside an edge module
      effect: read
      questions:
      - Which components does an IoT Edge module on my device define?
      - What are the component names within a device's module?
      instructions:
      - text: List the components in module {module} of device {device}.
        slots:
          module: path.moduleName
          device: path.deviceId
      - text: Show module {module}'s components.
        slots:
          module: path.moduleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules/{moduleName}/components/{componentName}/commands/{commandName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a module component command's history
      effect: read
      questions:
      - How do I see past results of a command on a component inside an edge module?
      - Did a command on a module's component succeed previously?
      instructions:
      - text: Get history of {command} on component {component} in module {module} of device {device}.
        slots:
          command: path.commandName
          component: path.componentName
          module: path.moduleName
          device: path.deviceId
      - text: Show earlier runs of {command} for module {module}'s {component} component.
        slots:
          command: path.commandName
          module: path.moduleName
          component: path.componentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules/{moduleName}/components/{componentName}/commands/{commandName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a command on a module component
      effect: write
      questions:
      - How do I invoke a command on a component that lives inside an edge module?
      - Can I target one component of an IoT Edge module with a command?
      instructions:
      - text: Run {command} on component {component} of module {module} on device {device}.
        slots:
          command: path.commandName
          component: path.componentName
          module: path.moduleName
          device: path.deviceId
      - text: Invoke {command} on module {module}'s {component} component with payload {request}.
        slots:
          command: path.commandName
          module: path.moduleName
          component: path.componentName
          request: requestBody.request
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a module component's properties
      effect: read
      questions:
      - What properties does a component inside an edge module report?
      - How do I read property values for one component of a module?
      instructions:
      - text: Get the properties of component {component} in module {module} on device {device}.
        slots:
          component: path.componentName
          module: path.moduleName
          device: path.deviceId
      - text: Show property values for module {module}'s {component} component.
        slots:
          module: path.moduleName
          component: path.componentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a module component's properties
      effect: write
      questions:
      - How do I overwrite all properties of a component inside an edge module?
      - Can I replace a module component's whole property set in one request?
      instructions:
      - text: Replace all properties of component {component} in module {module} on device {device}.
        slots:
          component: path.componentName
          module: path.moduleName
          device: path.deviceId
      - text: Overwrite every property on module {module}'s {component} component.
        slots:
          module: path.moduleName
          component: path.componentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules/{moduleName}/components/{componentName}/properties'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update some module component properties
      effect: write
      questions:
      - Can I change just one property on a component inside an edge module?
      - How do I partially patch a module component's writable properties?
      instructions:
      - text: Patch selected properties of component {component} in module {module} on device {device}.
        slots:
          component: path.componentName
          module: path.moduleName
          device: path.deviceId
      - text: Change a single setting on module {module}'s {component} component.
        slots:
          module: path.moduleName
          component: path.componentName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules/{moduleName}/components/{componentName}/telemetry/{telemetryName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get last telemetry from a module component
      effect: read
      questions:
      - What is the latest telemetry reading from a component inside an edge module?
      - How do I read the last value a module component reported for a metric?
      instructions:
      - text: Get the last {telemetry} value from component {component} in module {module} on device {device}.
        slots:
          telemetry: path.telemetryName
          component: path.componentName
          module: path.moduleName
          device: path.deviceId
      - text: Show module {module} component {component}'s latest {telemetry}.
        slots:
          module: path.moduleName
          component: path.componentName
          telemetry: path.telemetryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules/{moduleName}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an edge module's properties
      effect: read
      questions:
      - What property values does an IoT Edge module currently have?
      - How do I read all properties of a module on a device?
      instructions:
      - text: Get all properties of module {module} on device {device}.
        slots:
          module: path.moduleName
          device: path.deviceId
      - text: Show edge module {module}'s current property values.
        slots:
          module: path.moduleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules/{moduleName}/properties'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an edge module's properties
      effect: write
      questions:
      - How do I overwrite every property value of an IoT Edge module?
      - Can I replace a module's whole property set at once?
      instructions:
      - text: Replace all property values of module {module} on device {device}.
        slots:
          module: path.moduleName
          device: path.deviceId
      - text: Overwrite edge module {module}'s full property set.
        slots:
          module: path.moduleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules/{moduleName}/properties'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update some edge module properties
      effect: write
      questions:
      - Can I update a few module property values without replacing the others?
      - How do I patch the writable properties of an edge module?
      instructions:
      - text: Patch selected property values of module {module} on device {device}.
        slots:
          module: path.moduleName
          device: path.deviceId
      - text: Change one setting on edge module {module}.
        slots:
          module: path.moduleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/modules/{moduleName}/telemetry/{telemetryName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get last telemetry value from a module
      effect: read
      questions:
      - What was the latest telemetry value an edge module sent?
      - How do I read the most recent metric reported by a module?
      instructions:
      - text: Get the last {telemetry} value from module {module} on device {device}.
        slots:
          telemetry: path.telemetryName
          module: path.moduleName
          device: path.deviceId
      - text: Show edge module {module}'s newest {telemetry} reading.
        slots:
          module: path.moduleName
          telemetry: path.telemetryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IoT Central device's properties
      effect: read
      questions:
      - What reported and writable property values does my IoT Central device have?
      - Can I include unmodeled properties when reading a device's properties?
      instructions:
      - text: Get all property values of device {device}.
        slots:
          device: path.deviceId
      - text: Show device {device}'s properties including unmodeled ones.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/properties'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an IoT Central device's properties
      effect: write
      questions:
      - How do I overwrite every writable property of a device at once?
      - Can I replace a device's entire property set in IoT Central?
      instructions:
      - text: Replace all property values of device {device}.
        slots:
          device: path.deviceId
      - text: Overwrite the full set of writable properties on {device}.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/properties'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update some IoT Central device properties
      effect: write
      questions:
      - Can I change one writable property on a device without resending the others?
      - How do I partially update a device's property values?
      instructions:
      - text: Patch selected property values of device {device}.
        slots:
          device: path.deviceId
      - text: Change the fan speed setting on device {device}.
        slots:
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/relationships'].get
  update:
    x-apievangelist-phrasing:
      intent: List a gateway device's relationships
      effect: read
      questions:
      - Which downstream devices are attached to my IoT Central gateway?
      - How do I see the upstream and downstream relationships of a device?
      instructions:
      - text: List the relationships of device {device}.
        slots:
          device: path.deviceId
      - text: Show up to {max} downstream relationships for gateway {device}.
        slots:
          max: query.maxpagesize
          device: path.deviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/relationships/{relationshipId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device relationship
      effect: read
      questions:
      - How do I look up the source and target of one device relationship?
      - Can I fetch a specific gateway relationship by its ID?
      instructions:
      - text: Get relationship {relationship} of device {device}.
        slots:
          relationship: path.relationshipId
          device: path.deviceId
      - text: Show the source and target of relationship {relationship}.
        slots:
          relationship: path.relationshipId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/relationships/{relationshipId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a device relationship
      effect: write
      questions:
      - How do I attach a downstream device to a gateway in IoT Central?
      - Can I link two devices with a new relationship?
      instructions:
      - text: Create relationship {relationship} from device {device} to {target}.
        slots:
          relationship: path.relationshipId
          device: path.deviceId
          target: requestBody.target
      - text: Attach downstream device {target} to gateway {device} as relationship {relationship}.
        slots:
          target: requestBody.target
          device: path.deviceId
          relationship: path.relationshipId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/relationships/{relationshipId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device relationship
      effect: destructive
      questions:
      - How do I detach a downstream device from its gateway?
      - Can I delete a relationship from either the upstream or the downstream device?
      instructions:
      - text: Delete relationship {relationship} on device {device}.
        slots:
          relationship: path.relationshipId
          device: path.deviceId
      - text: Detach the gateway link {relationship}.
        slots:
          relationship: path.relationshipId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/relationships/{relationshipId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a device relationship
      effect: write
      questions:
      - Can I modify an existing relationship between a gateway and a device?
      - How do I patch a device relationship that already exists?
      instructions:
      - text: Patch relationship {relationship} on device {device}.
        slots:
          relationship: path.relationshipId
          device: path.deviceId
      - text: Update the existing gateway relationship {relationship}.
        slots:
          relationship: path.relationshipId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{deviceId}/telemetry/{telemetryName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device's last telemetry value
      effect: read
      questions:
      - What was the last humidity reading my IoT Central device sent?
      - How do I read a device's most recent telemetry value for one metric?
      instructions:
      - text: Get the last {telemetry} value from device {device}.
        slots:
          telemetry: path.telemetryName
          device: path.deviceId
      - text: Show device {device}'s latest {telemetry}.
        slots:
          device: path.deviceId
          telemetry: path.telemetryName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List Azure Sphere devices in a device group
      effect: read
      questions:
      - Which Azure Sphere devices belong to a device group?
      - How do I list devices for a product and device group in a Sphere catalog?
      instructions:
      - text: List Azure Sphere devices in group {group} of product {product} in catalog {catalog}.
        slots:
          group: path.deviceGroupName
          product: path.productName
          catalog: path.catalogName
      - text: Show all devices assigned to Sphere device group {group}.
        slots:
          group: path.deviceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Azure Sphere device
      effect: read
      questions:
      - How do I look up one Azure Sphere device in my catalog?
      - Can I get a Sphere device that is not in any device group?
      instructions:
      - text: Get Azure Sphere device {device} in group {group}, product {product}, catalog {catalog}.
        slots:
          device: path.deviceName
          group: path.deviceGroupName
          product: path.productName
          catalog: path.catalogName
      - text: Show Sphere device {device}'s details.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Claim an Azure Sphere device
      effect: write
      questions:
      - How do I claim an Azure Sphere device into my catalog?
      - Can I claim a Sphere device to the catalog only without a device group?
      instructions:
      - text: Claim Azure Sphere device {device} into catalog {catalog}, product {product}, group {group}.
        slots:
          device: path.deviceName
          catalog: path.catalogName
          product: path.productName
          group: path.deviceGroupName
      - text: Add Sphere device {device} to my catalog as unassigned.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Azure Sphere device
      effect: destructive
      questions:
      - How do I remove an Azure Sphere device from my catalog?
      - Can I delete a Sphere device record from a device group?
      instructions:
      - text: Delete Azure Sphere device {device} from group {group}, product {product}, catalog {catalog}.
        slots:
          device: path.deviceName
          group: path.deviceGroupName
          product: path.productName
          catalog: path.catalogName
      - text: Remove Sphere device {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Move or update an Azure Sphere device
      effect: write
      questions:
      - How do I move an Azure Sphere device to a different device group?
      - Can I move a Sphere device back to the catalog level?
      instructions:
      - text: Update Azure Sphere device {device} in catalog {catalog}, product {product}, group {group}.
        slots:
          device: path.deviceName
          catalog: path.catalogName
          product: path.productName
          group: path.deviceGroupName
      - text: Move Sphere device {device} with properties {properties}.
        slots:
          device: path.deviceName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}/generateCapabilityImage'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate an Azure Sphere capability image
      effect: write
      questions:
      - How do I generate a capability image to unlock debugging on an Azure Sphere device?
      - Which capabilities can be included in a Sphere device capability image?
      instructions:
      - text: Generate a capability image for Sphere device {device} with capabilities {capabilities}.
        slots:
          device: path.deviceName
          capabilities: requestBody.capabilities
      - text: Create a capability image for device {device} in group {group}, product {product}, catalog {catalog}.
        slots:
          device: path.deviceName
          group: path.deviceGroupName
          product: path.productName
          catalog: path.catalogName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices'].get
  update:
    x-apievangelist-phrasing:
      intent: List Data Box Edge devices in a subscription
      effect: read
      questions:
      - Which Azure Stack Edge and Data Box Gateway devices exist across my subscription?
      - How do I see every Data Box Edge device regardless of resource group?
      instructions:
      - text: List all Data Box Edge devices in subscription {sub}.
        slots:
          sub: path.subscriptionId
      - text: Show every Data Box Gateway device in my subscription.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices'].get
  update:
    x-apievangelist-phrasing:
      intent: List Data Box Edge devices in a resource group
      effect: read
      questions:
      - Which Data Box Edge devices are in a particular resource group?
      - How do I list Azure Stack Edge devices for one resource group?
      instructions:
      - text: List Data Box Edge devices in resource group {rg} of subscription {sub}.
        slots:
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the Azure Stack Edge devices in group {rg}.
        slots:
          rg: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Data Box Edge device
      effect: read
      questions:
      - How do I see the properties of one Azure Stack Edge device?
      - What SKU and status does my Data Box Gateway device have?
      instructions:
      - text: Get Data Box Edge device {device} in group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show Azure Stack Edge device {device}'s properties.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a Data Box Edge resource
      effect: write
      questions:
      - How do I create a new Azure Stack Edge resource in a region?
      - Can I choose the SKU when creating a Data Box Gateway resource?
      instructions:
      - text: Create Data Box Edge device {device} in {location} under group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          location: requestBody.location
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Create Azure Stack Edge resource {device} with SKU {sku}.
        slots:
          device: path.deviceName
          sku: requestBody.sku
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Data Box Edge device
      effect: destructive
      questions:
      - How do I delete an Azure Stack Edge resource I no longer use?
      - Can I remove a Data Box Gateway device from my subscription?
      instructions:
      - text: Delete Data Box Edge device {device} in group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Remove Azure Stack Edge device {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Modify a Data Box Edge resource
      effect: write
      questions:
      - Can I change the tags on an existing Azure Stack Edge device?
      - How do I modify a Data Box Gateway resource's identity or properties?
      instructions:
      - text: Update tags on Data Box Edge device {device} in group {rg}, subscription {sub} to {tags}.
        slots:
          device: path.deviceName
          rg: path.resourceGroupName
          sub: path.subscriptionId
          tags: requestBody.tags
      - text: Patch Azure Stack Edge device {device} with properties {properties}.
        slots:
          device: path.deviceName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates'].post
  update:
    x-apievangelist-phrasing:
      intent: Download updates to a Data Box Edge device
      effect: write
      questions:
      - How do I start downloading pending updates onto my Azure Stack Edge device?
      - Can I pre-download Data Box Gateway updates before installing them?
      instructions:
      - text: Download updates on Data Box Edge device {device} in group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Start the update download for Azure Stack Edge {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/generateCertificate'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate an activation key certificate
      effect: write
      questions:
      - How do I generate the certificate for a Data Box Edge activation key?
      - Where do I get the activation certificate for an Azure Stack Edge device?
      instructions:
      - text: Generate the activation key certificate for Data Box Edge device {device} in group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Create an activation certificate for {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation'].post
  update:
    x-apievangelist-phrasing:
      intent: Get extended info for a Data Box Edge device
      effect: read
      questions:
      - What extended information, like encryption key details, does my Azure Stack Edge device have?
      - How do I fetch additional details about a Data Box Gateway device?
      instructions:
      - text: Get extended information for Data Box Edge device {device} in group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the additional details of Azure Stack Edge {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates'].post
  update:
    x-apievangelist-phrasing:
      intent: Install updates on a Data Box Edge device
      effect: write
      questions:
      - How do I install downloaded updates on an Azure Stack Edge device?
      - Can I trigger update installation on a Data Box Gateway remotely?
      instructions:
      - text: Install updates on Data Box Edge device {device} in group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Apply the downloaded updates to Azure Stack Edge {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Data Box Edge device's network settings
      effect: read
      questions:
      - What network adapters and IP settings does my Azure Stack Edge device use?
      - How do I view the network configuration of a Data Box Gateway?
      instructions:
      - text: Get network settings of Data Box Edge device {device} in group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the IP configuration of Azure Stack Edge {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates'].post
  update:
    x-apievangelist-phrasing:
      intent: Scan for updates on a Data Box Edge device
      effect: write
      questions:
      - How do I check whether new updates are available for my Azure Stack Edge device?
      - Can I make a Data Box Gateway look for updates now?
      instructions:
      - text: Scan for updates on Data Box Edge device {device} in group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Check Azure Stack Edge {device} for available updates.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a Data Box Edge device's security settings
      effect: write
      questions:
      - How do I change the device admin password on an Azure Stack Edge device?
      - Can I update security settings on a Data Box Gateway remotely?
      instructions:
      - text: Update security settings on Data Box Edge device {device} in group {rg}, subscription {sub} to {properties}.
        slots:
          device: path.deviceName
          rg: path.resourceGroupName
          sub: path.subscriptionId
          properties: requestBody.properties
      - text: Reset the admin password on Azure Stack Edge {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateExtendedInformation'].post
  update:
    x-apievangelist-phrasing:
      intent: Update extended info on a Data Box Edge device
      effect: write
      questions:
      - How do I point my Azure Stack Edge device at a new client secret store?
      - Can I change the channel integrity key used by a Data Box Edge device?
      instructions:
      - text: Set the client secret store of Data Box Edge device {device} in group {rg}, subscription {sub} to {store_url}.
        slots:
          device: path.deviceName
          rg: path.resourceGroupName
          sub: path.subscriptionId
          store_url: requestBody.clientSecretStoreUrl
      - text: Update channel integrity key {key} on Azure Stack Edge {device}.
        slots:
          key: requestBody.channelIntegrityKeyName
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get update summary for a Data Box Edge device
      effect: read
      questions:
      - Are there updates available from the last scan of my Azure Stack Edge device?
      - Is an update download or install job running on my Data Box Gateway?
      instructions:
      - text: Get the update summary of Data Box Edge device {device} in group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show pending updates and running update jobs on Azure Stack Edge {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a Data Box Edge registration certificate
      effect: write
      questions:
      - How do I upload the registration certificate for an Azure Stack Edge device?
      - What do I send to register a Data Box Gateway with a certificate?
      instructions:
      - text: Upload registration certificate {certificate} to Data Box Edge device {device} in group {rg}, subscription {sub}.
        slots:
          certificate: requestBody.properties
          device: path.deviceName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Register Azure Stack Edge {device} with a certificate.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/configureDevice'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete initial setup of a StorSimple device
      effect: write
      questions:
      - How do I finish the minimal setup on a new StorSimple device before using it?
      - What settings are needed to configure a StorSimple device for the first time?
      instructions:
      - text: Configure a StorSimple device under manager {manager} in group {rg}, subscription {sub} with {properties}.
        slots:
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
          properties: requestBody.properties
      - text: Run first-time setup for a device in StorSimple manager {manager}.
        slots:
          manager: path.managerName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List devices in a StorSimple manager
      effect: read
      questions:
      - Which devices are registered to my StorSimple Device Manager?
      - How do I list all StorSimple appliances for a manager?
      instructions:
      - text: List devices in StorSimple manager {manager} in group {rg}, subscription {sub}.
        slots:
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show every StorSimple appliance registered to {manager}.
        slots:
          manager: path.managerName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a StorSimple device
      effect: read
      questions:
      - How do I see the properties and status of one StorSimple device?
      - What model and software version is a StorSimple appliance running?
      instructions:
      - text: Get StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show StorSimple appliance {device}'s properties.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a StorSimple device
      effect: destructive
      questions:
      - How do I remove a deactivated StorSimple device from the manager?
      - Can I delete a StorSimple appliance record?
      instructions:
      - text: Delete StorSimple device {device} from manager {manager} in group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Remove StorSimple appliance {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a StorSimple device
      effect: write
      questions:
      - Can I change the description or settings on a StorSimple device?
      - How do I patch a StorSimple appliance's properties?
      instructions:
      - text: Patch StorSimple device {device} in manager {manager}, group {rg}, subscription {sub} with {properties}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
          properties: requestBody.properties
      - text: Update the properties of StorSimple appliance {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/authorizeForServiceEncryptionKeyRollover'].post
  update:
    x-apievangelist-phrasing:
      intent: Authorize a device for encryption key rollover
      effect: write
      questions:
      - How do I authorize a StorSimple device to roll over the service data encryption key?
      - Which device should start a service encryption key rollover?
      instructions:
      - text: Authorize StorSimple device {device} in manager {manager}, group {rg}, subscription {sub} for key rollover.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Allow {device} to roll the service data encryption key.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a StorSimple device
      effect: destructive
      questions:
      - How do I deactivate a StorSimple device before retiring it?
      - Is deactivating a StorSimple appliance reversible?
      instructions:
      - text: Deactivate StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Deactivate appliance {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/installUpdates'].post
  update:
    x-apievangelist-phrasing:
      intent: Download and install StorSimple updates
      effect: write
      questions:
      - How do I download and install updates on a StorSimple device in one step?
      - Can I have a StorSimple appliance fetch and apply its updates together?
      instructions:
      - text: Download and install updates on StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Fetch and apply all updates to appliance {device} in one go.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/listFailoverSets'].post
  update:
    x-apievangelist-phrasing:
      intent: List failover sets for a StorSimple device
      effect: read
      questions:
      - Which volume container sets on a StorSimple device can be failed over together?
      - Are my StorSimple volume containers eligible to participate in a failover?
      instructions:
      - text: List failover sets of StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show failover eligibility for volume container sets on {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for a StorSimple device
      effect: read
      questions:
      - How do I pull capacity or throughput metrics for a StorSimple device?
      - Can I filter StorSimple device metrics by name and time range?
      instructions:
      - text: Get metrics for StorSimple device {device} in manager {manager}, group {rg}, subscription {sub} filtered by {filter}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
          filter: query.$filter
      - text: Show metrics matching {filter} for appliance {device}.
        slots:
          filter: query.$filter
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/metricsDefinitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric definitions for a StorSimple device
      effect: read
      questions:
      - Which metrics can I query for a StorSimple device?
      - What metric names and units does a StorSimple appliance expose?
      instructions:
      - text: List metric definitions for StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the available metric names for appliance {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/scanForUpdates'].post
  update:
    x-apievangelist-phrasing:
      intent: Scan for updates on a StorSimple device
      effect: write
      questions:
      - How do I make a StorSimple appliance check for new updates?
      - Can I trigger an update scan on a StorSimple device?
      instructions:
      - text: Scan for updates on StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Look for new software updates on appliance {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/updateSummary/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get update summary for a StorSimple device
      effect: read
      questions:
      - What updates are pending on my StorSimple appliance?
      - When was a StorSimple device last updated?
      instructions:
      - text: Get the update summary for StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the update status of appliance {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{sourceDeviceName}/failover'].post
  update:
    x-apievangelist-phrasing:
      intent: Fail over volume containers to another device
      effect: write
      questions:
      - How do I fail over a set of StorSimple volume containers to a target device?
      - Can I choose which volume containers move during a StorSimple 8000 failover?
      instructions:
      - text: Fail over volume containers {containers} from {source} to target device {target}.
        slots:
          containers: requestBody.volumeContainers
          source: path.sourceDeviceName
          target: requestBody.targetDeviceId
      - text: Move volume containers from source device {source} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          source: path.sourceDeviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{sourceDeviceName}/listFailoverTargets'].post
  update:
    x-apievangelist-phrasing:
      intent: Check failover target eligibility
      effect: read
      questions:
      - Which StorSimple devices are eligible targets for failing over given volume containers?
      - Before failover, how do I confirm a target device can accept my volume containers?
      instructions:
      - text: List eligible failover targets for volume containers {containers} from {source}.
        slots:
          containers: requestBody.volumeContainers
          source: path.sourceDeviceName
      - text: Check failover targets for source device {source} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          source: path.sourceDeviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/alertSettings/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a StorSimple device's alert settings
      effect: read
      questions:
      - Who receives email alerts from my StorSimple device?
      - Are alert notifications turned on for a StorSimple appliance?
      instructions:
      - text: Get alert settings for StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the alert email recipients for {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/alertSettings/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a StorSimple device's alert settings
      effect: write
      questions:
      - How do I change which emails get StorSimple device alerts?
      - Can I enable alert notifications on a StorSimple appliance?
      instructions:
      - text: Set alert settings on StorSimple device {device} in manager {manager}, group {rg}, subscription {sub} to {properties}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
          properties: requestBody.properties
      - text: Turn on email alerts for appliance {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/download'].post
  update:
    x-apievangelist-phrasing:
      intent: Download updates to a StorSimple device
      effect: write
      questions:
      - How do I download available updates onto a StorSimple device without installing them?
      - Can I stage StorSimple updates for installation later?
      instructions:
      - text: Download updates to StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Stage the pending updates on appliance {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/failover'].post
  update:
    x-apievangelist-phrasing:
      intent: Fail over a StorSimple device
      effect: write
      questions:
      - How do I fail over a whole StorSimple device to another device?
      - Can I keep the source device or skip validation during a StorSimple failover?
      instructions:
      - text: Fail over StorSimple device {device} to {target} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          target: requestBody.targetDeviceId
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Fail over {device} to {target} and keep the source device.
        slots:
          device: path.deviceName
          target: requestBody.targetDeviceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/failoverTargets'].get
  update:
    x-apievangelist-phrasing:
      intent: List devices usable as failover targets
      effect: read
      questions:
      - Which StorSimple devices can act as failover targets for a given device?
      - Where can I fail over my StorSimple appliance to?
      instructions:
      - text: List failover target devices for StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show which appliances could take over for {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/install'].post
  update:
    x-apievangelist-phrasing:
      intent: Install downloaded StorSimple updates
      effect: write
      questions:
      - How do I install updates already downloaded on a StorSimple device?
      - Can I apply staged updates on a StorSimple appliance?
      instructions:
      - text: Install updates on StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Apply staged updates to appliance {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/networkSettings/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a StorSimple device's network settings
      effect: read
      questions:
      - What DNS and network interface settings does my StorSimple device use?
      - How do I review a StorSimple appliance's network configuration?
      instructions:
      - text: Get network settings of StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show DNS and interface settings on appliance {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/securitySettings/default/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a StorSimple device's security settings
      effect: write
      questions:
      - How do I change the remote management or password settings on a StorSimple device?
      - Can I update the security configuration of a StorSimple appliance?
      instructions:
      - text: Update security settings on StorSimple device {device} in manager {manager}, group {rg}, subscription {sub} to {properties}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
          properties: requestBody.properties
      - text: Change remote management settings on appliance {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/timeSettings/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a StorSimple device's time settings
      effect: read
      questions:
      - Which time zone and NTP servers is my StorSimple device using?
      - How do I check the clock settings on a StorSimple appliance?
      instructions:
      - text: Get time settings for StorSimple device {device} in manager {manager}, group {rg}, subscription {sub}.
        slots:
          device: path.deviceName
          manager: path.managerName
          rg: path.resourceGroupName
          sub: path.subscriptionId
      - text: Show the time zone and NTP servers on {device}.
        slots:
          device: path.deviceName
      method: generated
      generated: '2026-09-26'