# 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 Roles API
  version: 1.0.0
extends: openapi/microsoft-azure-roles-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: 14
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles/{roleName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role on a PostgreSQL cluster
      effect: read
      questions:
      - How do I look up one database role on my Azure PostgreSQL cluster?
      - What permissions does a specific role on a Postgres cluster have?
      instructions:
      - text: Get role {roleName} on PostgreSQL cluster {clusterName}.
        slots:
          roleName: path.roleName
          clusterName: path.clusterName
      - text: Show the details of cluster role {roleName} in {clusterName}.
        slots:
          roleName: path.roleName
          clusterName: path.clusterName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles/{roleName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a role on a PostgreSQL cluster
      effect: write
      questions:
      - Can I add a new database role to my Azure PostgreSQL cluster through the API?
      - How do I change an existing role on a Postgres cluster?
      instructions:
      - text: Create role {roleName} on PostgreSQL cluster {clusterName}.
        slots:
          roleName: path.roleName
          clusterName: path.clusterName
      - text: Create or update cluster role {roleName} in {clusterName} with the given properties.
        slots:
          roleName: path.roleName
          clusterName: path.clusterName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles/{roleName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a role from a PostgreSQL cluster
      effect: destructive
      questions:
      - How do I drop a role from my Azure PostgreSQL cluster?
      - Is removing a cluster role permanent?
      instructions:
      - text: Delete role {roleName} from PostgreSQL cluster {clusterName}.
        slots:
          roleName: path.roleName
          clusterName: path.clusterName
      - text: Remove the cluster role {roleName} on {clusterName}.
        slots:
          roleName: path.roleName
          clusterName: path.clusterName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles on a PostgreSQL cluster
      effect: read
      questions:
      - Which roles exist on my Azure PostgreSQL cluster?
      - Can I see every database role defined in a Postgres cluster?
      instructions:
      - text: List all roles on PostgreSQL cluster {clusterName}.
        slots:
          clusterName: path.clusterName
      - text: Show every role defined in cluster {clusterName}.
        slots:
          clusterName: path.clusterName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List the roles in an application
      effect: read
      questions:
      - What roles are defined in my application?
      - Can I get the full list of application roles in one call?
      instructions:
      - text: List the roles in my application.
      - text: Show every application role using API version {apiVersion}.
        slots:
          apiVersion: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/roles/{roleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application role by ID
      effect: read
      questions:
      - How do I fetch one application role when I know its ID?
      - What does a particular application role contain?
      instructions:
      - text: Get application role {roleId}.
        slots:
          roleId: path.roleId
      - text: Show the details of the role with ID {roleId}.
        slots:
          roleId: path.roleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles for a Customer Insights hub
      effect: read
      questions:
      - Which roles are available in my Customer Insights hub?
      - Can I list the access roles defined for a Customer Insights hub?
      instructions:
      - text: List the roles for Customer Insights hub {hubName} in resource group {resourceGroupName} (subscription {subscriptionId}).
        slots:
          hubName: path.hubName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show hub {hubName} roles in {resourceGroupName}.
        slots:
          hubName: path.hubName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles on a Data Box Edge device
      effect: read
      questions:
      - What roles are configured on my Data Box Edge or Data Box Gateway device?
      - Can I see which compute roles are set up on an edge device?
      instructions:
      - text: List the roles on Data Box Edge device {deviceName} in {resourceGroupName} (subscription {subscriptionId}).
        slots:
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show every role configured on edge device {deviceName} in resource group {resourceGroupName}.
        slots:
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role on a Data Box Edge device
      effect: read
      questions:
      - How do I read a single role's settings on a Data Box Edge device?
      - What kind of role is a named role on my edge device?
      instructions:
      - text: Get role {name} on Data Box Edge device {deviceName} in {resourceGroupName} (subscription {subscriptionId}).
        slots:
          name: path.name
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show the settings for edge device role {name} on {deviceName}, resource group {resourceGroupName}.
        slots:
          name: path.name
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a role on a Data Box Edge device
      effect: write
      questions:
      - How do I add a compute role such as IoT to a Data Box Edge device?
      - Which role kind do I have to specify when configuring an edge device role?
      instructions:
      - text: Create a {kind} role named {name} on Data Box Edge device {deviceName} in {resourceGroupName} (subscription {subscriptionId}).
        slots:
          kind: requestBody.kind
          name: path.name
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Update edge device role {name} on {deviceName} in {resourceGroupName} as kind {kind}.
        slots:
          name: path.name
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
          kind: requestBody.kind
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a role from a Data Box Edge device
      effect: destructive
      questions:
      - How do I remove a role from my Data Box Edge device?
      - Can I delete a compute role on an edge gateway without resetting the device?
      instructions:
      - text: Delete role {name} from Data Box Edge device {deviceName} in {resourceGroupName} (subscription {subscriptionId}).
        slots:
          name: path.name
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove the edge device role {name} on {deviceName}, resource group {resourceGroupName}.
        slots:
          name: path.name
          deviceName: path.deviceName
          resourceGroupName: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/roles/{roleName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a role on a Postgres server group
      effect: write
      questions:
      - How do I add a role to a Hyperscale Postgres server group?
      - Can I update an existing role on a server group rather than a cluster?
      instructions:
      - text: Create role {roleName} on Postgres server group {serverGroupName}.
        slots:
          roleName: path.roleName
          serverGroupName: path.serverGroupName
      - text: Create or update server group role {roleName} in {serverGroupName}.
        slots:
          roleName: path.roleName
          serverGroupName: path.serverGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/roles/{roleName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a role from a Postgres server group
      effect: destructive
      questions:
      - How do I remove a role from a Hyperscale Postgres server group?
      - Does deleting a server group role affect other roles on the group?
      instructions:
      - text: Delete role {roleName} from Postgres server group {serverGroupName}.
        slots:
          roleName: path.roleName
          serverGroupName: path.serverGroupName
      - text: Remove server group role {roleName} on {serverGroupName}.
        slots:
          roleName: path.roleName
          serverGroupName: path.serverGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles on a Postgres server group
      effect: read
      questions:
      - Which roles exist on my Hyperscale Postgres server group?
      - Can I see every role configured on a server group?
      instructions:
      - text: List all roles on Postgres server group {serverGroupName}.
        slots:
          serverGroupName: path.serverGroupName
      - text: Show every role defined in server group {serverGroupName}.
        slots:
          serverGroupName: path.serverGroupName
      method: generated
      generated: '2026-09-26'