# 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 GET API
  version: 1.0.0
extends: openapi/microsoft-azure-get-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: 17
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IoT hub's metadata
      effect: read
      questions:
      - How do I look up the non-security metadata for one of my IoT hubs?
      - What SKU, location and settings does a particular IoT hub have?
      instructions:
      - text: Get IoT hub {resourceName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the configuration of IoT hub {resourceName}.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs'].get
  update:
    x-apievangelist-phrasing:
      intent: List IoT hubs in a subscription
      effect: read
      questions:
      - Which IoT hubs exist across my whole Azure subscription?
      - Can I see every IoT hub I own regardless of resource group?
      instructions:
      - text: List all IoT hubs in subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      - text: Show every IoT hub across my subscription.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs'].get
  update:
    x-apievangelist-phrasing:
      intent: List IoT hubs in a resource group
      effect: read
      questions:
      - What IoT hubs live in one specific resource group?
      - Is there a call that returns only the IoT hubs inside a single resource group?
      instructions:
      - text: List the IoT hubs in resource group {resourceGroupName} of subscription {subscriptionId}.
        slots:
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show IoT hubs deployed to {resourceGroupName}.
        slots:
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IoT hub's device statistics
      effect: read
      questions:
      - How many devices are registered and enabled on my IoT hub?
      - Where can I read the device counts and statistics for an IoT hub?
      instructions:
      - text: Get the statistics for IoT hub {resourceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show device registry stats for IoT hub {resourceName}.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus'].get
  update:
    x-apievangelist-phrasing:
      intent: List valid SKUs for an IoT hub
      effect: read
      questions:
      - Which pricing tiers can I scale my existing IoT hub to?
      - What SKUs and capacities are valid for a given IoT hub?
      instructions:
      - text: List the valid SKUs for IoT hub {resourceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show which tiers IoT hub {resourceName} can move to.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List consumer groups on an IoT hub endpoint
      effect: read
      questions:
      - What consumer groups are defined on my IoT hub's Event Hub-compatible endpoint?
      - Can I see all the readers configured on an IoT hub's device-to-cloud endpoint?
      instructions:
      - text: List consumer groups on endpoint {eventHubEndpointName} of IoT hub {resourceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          eventHubEndpointName: path.eventHubEndpointName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show all consumer groups on the {eventHubEndpointName} endpoint of hub {resourceName}.
        slots:
          eventHubEndpointName: path.eventHubEndpointName
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one consumer group on an IoT hub endpoint
      effect: read
      questions:
      - How do I fetch a single named consumer group from an IoT hub's device-to-cloud endpoint?
      - Does a consumer group with a particular name exist on my IoT hub endpoint?
      instructions:
      - text: Get consumer group {name} on endpoint {eventHubEndpointName} of IoT hub {resourceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          name: path.name
          eventHubEndpointName: path.eventHubEndpointName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Look up the {name} consumer group on hub {resourceName}.
        slots:
          name: path.name
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List jobs on an IoT hub
      effect: read
      questions:
      - What import and export jobs have run on my IoT hub?
      - Can I see every job an IoT hub has in its history?
      instructions:
      - text: List all jobs on IoT hub {resourceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the job history for IoT hub {resourceName}.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of an IoT hub job
      effect: read
      questions:
      - How do I check the status of one specific job on an IoT hub?
      - Did my IoT hub device import job finish, and what did it report?
      instructions:
      - text: Get job {jobId} on IoT hub {resourceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          jobId: path.jobId
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Check the status of IoT hub job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IoT hub's quota metrics
      effect: read
      questions:
      - How close is my IoT hub to its quota limits?
      - Which quota metrics does an IoT hub report, and what are their current values?
      instructions:
      - text: Get quota metrics for IoT hub {resourceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show how much of its quota IoT hub {resourceName} has used.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth'].get
  update:
    x-apievangelist-phrasing:
      intent: Check routing endpoint health on an IoT hub
      effect: read
      questions:
      - Are the message routing endpoints on my IoT hub healthy?
      - Which IoT hub routing endpoints are unhealthy or dead right now?
      instructions:
      - text: Get routing endpoint health for IoT hub {iotHubName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          iotHubName: path.iotHubName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Check whether the routing endpoints on hub {iotHubName} are healthy.
        slots:
          iotHubName: path.iotHubName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Devices/usages'].get
  update:
    x-apievangelist-phrasing:
      intent: Count free and paid IoT hubs in a subscription
      effect: read
      questions:
      - How many free and paid IoT hubs does my subscription have against its limit?
      - Can I create another free-tier IoT hub, or have I hit the subscription quota?
      instructions:
      - text: Get the IoT hub usage quota for subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      - text: Count my free and paid IoT hubs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources'].get
  update:
    x-apievangelist-phrasing:
      intent: List private link resources for an IoT hub
      effect: read
      questions:
      - What private link group IDs can I connect to on my IoT hub?
      - Which private link resources does an IoT hub expose?
      instructions:
      - text: List private link resources for IoT hub {resourceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the private link resources available on hub {resourceName}.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one private link resource of an IoT hub
      effect: read
      questions:
      - How do I read the details of a single private link group on an IoT hub?
      - What required members and DNS zones does an IoT hub private link group ID have?
      instructions:
      - text: Get private link resource {groupId} for IoT hub {resourceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          groupId: path.groupId
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show private link group {groupId} on hub {resourceName}.
        slots:
          groupId: path.groupId
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections'].get
  update:
    x-apievangelist-phrasing:
      intent: List private endpoint connections on an IoT hub
      effect: read
      questions:
      - Which private endpoints are connected to my IoT hub?
      - Are there pending private endpoint connections on an IoT hub waiting for approval?
      instructions:
      - text: List private endpoint connections for IoT hub {resourceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show every private endpoint connected to hub {resourceName}.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a private endpoint connection on an IoT hub
      effect: read
      questions:
      - How do I check the approval state of one private endpoint connection on my IoT hub?
      - What are the properties of a named private endpoint connection to an IoT hub?
      instructions:
      - text: Get private endpoint connection {privateEndpointConnectionName} on IoT hub {resourceName} in {resourceGroupName}, subscription {subscriptionId}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the status of connection {privateEndpointConnectionName} on hub {resourceName}.
        slots:
          privateEndpointConnectionName: path.privateEndpointConnectionName
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enrollments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device enrollment record
      effect: read
      questions:
      - How do I look up an individual device enrollment in the Device Provisioning Service?
      - What attestation and hub settings does a device's enrollment record hold?
      instructions:
      - text: Get the device enrollment record with registration ID {id}.
        slots:
          id: path.id
      - text: Show individual enrollment {id} using API version {apiVersion}.
        slots:
          id: path.id
          apiVersion: query.api-version
      method: generated
      generated: '2026-09-26'