# 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 Azure Bot Service Channel API
  version: 1.0.0
extends: openapi/microsoft-azure-channel-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: 8
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bot's channel registration
      effect: read
      questions:
      - How is a particular channel configured on my Azure bot?
      - Can I check whether a channel is registered on a Bot Service resource?
      instructions:
      - text: Show the {channelName} channel on bot {resourceName} in resource group {resourceGroupName}.
        slots:
          channelName: path.channelName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
      - text: Get channel registration {channelName} for bot {resourceName} in group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          channelName: path.channelName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Register a new channel on a bot
      effect: write
      questions:
      - How do I connect my Azure bot to a new channel such as Teams or Direct Line?
      - Can I add a channel registration to a Bot Service with its own settings?
      instructions:
      - text: Add the {channelName} channel to bot {resourceName} in resource group {resourceGroupName}.
        slots:
          channelName: path.channelName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
      - text: Create channel registration {channelName} on bot {resourceName} in group {resourceGroupName}, subscription {subscriptionId}, with properties {properties}.
        slots:
          channelName: path.channelName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a channel from a bot
      effect: destructive
      questions:
      - How do I disconnect my bot from a channel it's registered on?
      - What happens to a bot when I delete one of its channel registrations?
      instructions:
      - text: Delete the {channelName} channel from bot {resourceName} in resource group {resourceGroupName}.
        slots:
          channelName: path.channelName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
      - text: Remove channel registration {channelName} from bot {resourceName} in group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          channelName: path.channelName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a bot's existing channel settings
      effect: write
      questions:
      - How do I change the settings of a channel my bot is already connected to?
      - Can I disable or tweak an existing channel registration without recreating it?
      instructions:
      - text: Update the existing {channelName} channel on bot {resourceName} in resource group {resourceGroupName} with properties {properties}.
        slots:
          channelName: path.channelName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          properties: requestBody.properties
      - text: Patch channel registration {channelName} of bot {resourceName} in group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          channelName: path.channelName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/listChannelWithKeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a bot channel including its secrets
      effect: read
      questions:
      - How do I retrieve the secret keys for one of my bot's channels?
      - Can I see a channel registration with its secrets revealed?
      instructions:
      - text: Show the {channelName} channel on bot {resourceName} in resource group {resourceGroupName} including its secret keys.
        slots:
          channelName: path.channelName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
      - text: Reveal the secrets for channel {channelName} of bot {resourceName} in group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          channelName: path.channelName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List all channels registered on a bot
      effect: read
      questions:
      - Which channels is my Azure bot currently connected to?
      - Can I see every channel registration for one Bot Service resource?
      instructions:
      - text: List all channels on bot {resourceName} in resource group {resourceGroupName}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
      - text: Show every channel registration for bot {resourceName} in group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/regeneratekeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate Direct Line channel keys for a bot
      effect: destructive
      questions:
      - How do I rotate the secret keys for my bot's Direct Line site?
      - What happens to clients using the old key when I regenerate a Direct Line secret?
      instructions:
      - text: Regenerate key {key} for Direct Line site {siteName} on bot {resourceName} in resource group {resourceGroupName}.
        slots:
          key: requestBody.key
          siteName: requestBody.siteName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
      - text: Rotate the {channelName} secrets for site {siteName}, key {key}, on bot {resourceName} in group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          channelName: path.channelName
          siteName: requestBody.siteName
          key: requestBody.key
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/createEmailSignInUrl'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email channel sign-in URL for a bot
      effect: write
      questions:
      - How do I get the sign-in link needed to set up my bot's email channel?
      - Can I generate an email channel sign-in URL for a Bot Service?
      instructions:
      - text: Create an email channel sign-in URL for bot {resourceName} in resource group {resourceGroupName}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
      - text: Generate the email sign-in link for bot {resourceName} in group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      method: generated
      generated: '2026-09-26'