# 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 iotDpsClient Iot Dps Resource API
  version: 1.0.0
extends: openapi/microsoft-azure-iotdpsresource-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/provisioningServices/{provisioningServiceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Device Provisioning Service's details
      effect: read
      questions:
      - How do I view the settings of my IoT Hub Device Provisioning Service without exposing its keys?
      - What SKU, location and properties does a given provisioning service have?
      instructions:
      - text: Get provisioning service {service} in resource group {resource_group}, subscription {subscription}.
        slots:
          service: path.provisioningServiceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the non-secret metadata of DPS instance {service}.
        slots:
          service: path.provisioningServiceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a Device Provisioning Service
      effect: write
      questions:
      - How do I create a new IoT Hub Device Provisioning Service?
      - Which fields are required to set up a provisioning service, such as SKU and location?
      - Can I change a provisioning service's properties beyond its tags?
      instructions:
      - text: Create provisioning service {service} in {location} with SKU {sku} in resource group {resource_group}, subscription {subscription}.
        slots:
          service: path.provisioningServiceName
          location: requestBody.location
          sku: requestBody.sku
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Replace the full properties of DPS instance {service} with {properties}.
        slots:
          service: path.provisioningServiceName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Device Provisioning Service
      effect: destructive
      questions:
      - How do I tear down an IoT Hub Device Provisioning Service I no longer use?
      - Is deleting a provisioning service a long-running operation I need to track?
      instructions:
      - text: Delete provisioning service {service} in resource group {resource_group}, subscription {subscription}.
        slots:
          service: path.provisioningServiceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Remove DPS instance {service} permanently.
        slots:
          service: path.provisioningServiceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a provisioning service's tags
      effect: write
      questions:
      - How do I change only the tags on an existing Device Provisioning Service?
      - Can I retag a provisioning service without resending its full configuration?
      instructions:
      - text: Set tags {tags} on provisioning service {service} in resource group {resource_group}, subscription {subscription}.
        slots:
          tags: requestBody.tags
          service: path.provisioningServiceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Retag DPS instance {service} with {tags}.
        slots:
          service: path.provisioningServiceName
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Devices/provisioningServices'].get
  update:
    x-apievangelist-phrasing:
      intent: List provisioning services in a subscription
      effect: read
      questions:
      - Which Device Provisioning Services exist across my whole Azure subscription?
      - How can I inventory every DPS instance I own regardless of resource group?
      instructions:
      - text: List all provisioning services in subscription {subscription}.
        slots:
          subscription: path.subscriptionId
      - text: Inventory every DPS instance across subscription {subscription}.
        slots:
          subscription: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices'].get
  update:
    x-apievangelist-phrasing:
      intent: List provisioning services in a resource group
      effect: read
      questions:
      - What provisioning services are deployed in one particular resource group?
      - How do I list only the DPS instances inside a single resource group?
      instructions:
      - text: List provisioning services in resource group {resource_group}, subscription {subscription}.
        slots:
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the DPS instances that live in resource group {resource_group}.
        slots:
          resource_group: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/operationresults/{operationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a long-running provisioning service operation
      effect: read
      questions:
      - How do I check whether a create, update or delete on my provisioning service has finished?
      - Where can I poll the status of an async DPS operation?
      instructions:
      - text: Get the status of operation {operation_id} on provisioning service {service} using async info {asyncinfo}.
        slots:
          operation_id: path.operationId
          service: path.provisioningServiceName
          asyncinfo: query.asyncinfo
      - text: Poll long-running operation {operation_id} for DPS instance {service} in resource group {resource_group}, subscription {subscription}.
        slots:
          operation_id: path.operationId
          service: path.provisioningServiceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/skus'].get
  update:
    x-apievangelist-phrasing:
      intent: List valid SKUs for a provisioning service
      effect: read
      questions:
      - Which pricing tiers can my provisioning service be moved to?
      - What SKUs and tiers are valid for an existing DPS instance?
      instructions:
      - text: List the valid SKUs for provisioning service {service} in resource group {resource_group}, subscription {subscription}.
        slots:
          service: path.provisioningServiceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show which tiers DPS instance {service} can use.
        slots:
          service: path.provisioningServiceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if a provisioning service name is available
      effect: read
      questions:
      - Is a particular Device Provisioning Service name still free to use?
      - Can I validate a DPS name's syntax and availability before creating it?
      instructions:
      - text: Check whether the provisioning service name {name} is available in subscription {subscription}.
        slots:
          name: requestBody.name
          subscription: path.subscriptionId
      - text: Validate that {name} can be used as a new DPS name.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys'].post
  update:
    x-apievangelist-phrasing:
      intent: List all access keys for a provisioning service
      effect: read
      questions:
      - How do I get the primary and secondary keys for my provisioning service?
      - Where do I find every shared access policy and its keys on a DPS instance?
      instructions:
      - text: List all shared access keys for provisioning service {service} in resource group {resource_group}, subscription {subscription}.
        slots:
          service: path.provisioningServiceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the primary and secondary keys of every policy on DPS instance {service}.
        slots:
          service: path.provisioningServiceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/keys/{keyName}/listkeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the keys for one named access policy
      effect: read
      questions:
      - How do I fetch the keys for one specific shared access policy on a provisioning service?
      - Can I retrieve just the provisioningserviceowner policy keys by name?
      instructions:
      - text: Get the keys for access policy {key_name} on provisioning service {service} in resource group {resource_group}, subscription {subscription}.
        slots:
          key_name: path.keyName
          service: path.provisioningServiceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the primary and secondary key of policy {key_name} on DPS {service}.
        slots:
          key_name: path.keyName
          service: path.provisioningServiceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources'].get
  update:
    x-apievangelist-phrasing:
      intent: List private link resources for a provisioning service
      effect: read
      questions:
      - Which private link group IDs does my provisioning service support?
      - How do I see the private link resources available on a DPS instance?
      instructions:
      - text: List the private link resources of provisioning service {service} in resource group {resource_group}, subscription {subscription}.
        slots:
          service: path.resourceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show all private link group IDs for DPS {service}.
        slots:
          service: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one private link resource of a provisioning service
      effect: read
      questions:
      - What does a specific private link resource group on my provisioning service contain?
      - How do I look up one private link group by its group ID?
      instructions:
      - text: Get private link resource {group_id} of provisioning service {service} in resource group {resource_group}, subscription {subscription}.
        slots:
          group_id: path.groupId
          service: path.resourceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the {group_id} private link group on DPS {service}.
        slots:
          group_id: path.groupId
          service: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections'].get
  update:
    x-apievangelist-phrasing:
      intent: List private endpoint connections on a provisioning service
      effect: read
      questions:
      - Which private endpoints are connected to my provisioning service?
      - How do I review all pending and approved private endpoint connections on a DPS instance?
      instructions:
      - text: List private endpoint connections for provisioning service {service} in resource group {resource_group}, subscription {subscription}.
        slots:
          service: path.resourceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show every private endpoint attached to DPS {service}.
        slots:
          service: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one private endpoint connection
      effect: read
      questions:
      - How do I check the approval state of one private endpoint connection on a provisioning service?
      - What are the properties of a specific named private endpoint connection?
      instructions:
      - text: Get private endpoint connection {connection} on provisioning service {service} in resource group {resource_group}, subscription {subscription}.
        slots:
          connection: path.privateEndpointConnectionName
          service: path.resourceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Show the status of endpoint connection {connection} on DPS {service}.
        slots:
          connection: path.privateEndpointConnectionName
          service: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve or update a private endpoint connection
      effect: write
      questions:
      - How do I approve or reject a pending private endpoint connection on my provisioning service?
      - Can I change the connection state of an existing private endpoint?
      instructions:
      - text: Set private endpoint connection {connection} on provisioning service {service} to {properties}.
        slots:
          connection: path.privateEndpointConnectionName
          service: path.resourceName
          properties: requestBody.properties
      - text: Approve endpoint connection {connection} on DPS {service} in resource group {resource_group}, subscription {subscription}.
        slots:
          connection: path.privateEndpointConnectionName
          service: path.resourceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a private endpoint connection
      effect: destructive
      questions:
      - How do I disconnect a private endpoint from my provisioning service?
      - Can I remove a stale private endpoint connection by name?
      instructions:
      - text: Delete private endpoint connection {connection} from provisioning service {service} in resource group {resource_group}, subscription {subscription}.
        slots:
          connection: path.privateEndpointConnectionName
          service: path.resourceName
          resource_group: path.resourceGroupName
          subscription: path.subscriptionId
      - text: Disconnect endpoint connection {connection} from DPS {service}.
        slots:
          connection: path.privateEndpointConnectionName
          service: path.resourceName
      method: generated
      generated: '2026-09-26'